Javascript SDK

This is the base SDK for Openpanel. All other SDKs/frameworks are built on top of this one.

Installation

Install dependencies

pnpm install @openpanel/sdk

Initialize

import { OpenpanelSdk } from '@openpanel/sdk';
 
const op = new OpenpanelSdk({
  clientId: '{YOUR_CLIENT_ID}',
  // mostly for backend and apps that can't rely on CORS
  clientSecret: '{YOUR_CLIENT_SECRET}',
});

Config

url - The url of the openpanel API or your self-hosted instance
clientId - The client id of your application
clientSecret - The client secret of your application (mostly for backend and apps that can't rely on CORS)

Ready!

You're now ready to use the library.

// Sends an event with payload foo: bar
op.event('my_event', { foo: 'bar' });
 
// Identify with profile id
op.setProfileId('123');
 
// or with additional data
op.setProfile({
  profileId: '123',
  firstName: 'John',
  lastName: 'Doe',
  email: '[email protected]',
});
 
// Increment a property
op.increment('app_opened'); // increment by 1
op.increment('app_opened', 5); // increment by 5
 
// Decrement a property
op.decrement('app_opened'); // decrement by 1
op.decrement('app_opened', 5); // decrement by 5

Usage

Track event

op.event('my_event', { foo: 'bar' });

Identify

Set Profile Id

Keep track of your users by identifying them with a unique id. This is a good features if you have things behind a login and want to track user behavior.

⚠️

Keep in mind that this is considered personal data. Make sure you have the users consent before calling this!

const profileId = '123';
op.setProfileId(profileId);

Additional data

This method does the same as setProfileId but also allows you to update the profile with additional data.

⚠️

Keep in mind that this is considered personal data. Make sure you have the users consent before calling this!

const profileId = '123';
op.setProfile({
  profileId,
  // firstName?: string;
  // lastName?: string;
  // email?: string;
  // avatar?: string;
  // properties?: Record<string, unknown>;
});

Increment property

Increment a property on the profile.

// Increment by 1
op.increment('app_opened');
 
// Increment by 5
op.increment('app_opened', 5);

Decrement property

Decrement a property on the profile.

// Increment by 1
op.decrement('app_opened');
 
// Increment by 5
op.decrement('app_opened', 5);

Clear / Logout

Clear the profile id and all the data.

op.clear();

Express (backend)Web SDK