Documentation
Get Started

Documentation

The OpenPanel SDKs provide a set of core methods that allow you to track events, identify users, and more. Here's an overview of the key methods available in the SDKs.

💡

While all OpenPanel SDKs share a common set of core methods, some may have syntax variations or additional methods specific to their environment. This documentation provides an overview of the base methods and available SDKs.

Core Methods

setGlobalProperties

Sets global properties that will be included with every subsequent event.

track

Tracks a custom event with the given name and optional properties.

Tips

You can identify the user directly with this method.

Example shown in JavaScript
track('your_event_name', {
  foo: 'bar',
  baz: 'qux',
  // reserved property name
  __identify: {
    profileId: 'your_user_id', // required
    email: 'your_user_email',
    firstName: 'your_user_name',
    lastName: 'your_user_name',
    avatar: 'your_user_avatar',
  }
});

identify

Associates the current user with a unique identifier and optional traits.

alias

Creates an alias for a user identifier.

increment

Increments a numeric property for a user.

decrement

Decrements a numeric property for a user.

clear

Clears the current user identifier and ends the session.

Official SDKs

Unofficial SDKs

While not officially supported, the following community-contributed SDKs are available.