Identifying users

​

Usage

import { SessionRecorder } from '@web-analytics-ai/obweb';

const recorder = await SessionRecorder.init({
  apiKey: 'ob_live_your_api_key_here',
});

// After your user logs in or is known:
await recorder.identify('user_123', {
  plan: 'pro',
  company: 'Acme Inc',
});

​

Parameters

​

How traits are handled

• Trait values are converted to strings before sending. Nested objects arrive as their string representation, so prefer flat, scalar values.
• Empty or non-string keys are dropped.
• Traits are capped at 256KB total. If the cap is reached, remaining traits are dropped and a warning is logged.

​

Behavior notes

• identify() must be called after init() has resolved; it needs the backend session to exist. Called earlier, it logs a warning and does nothing.
• Calling identify() again updates the identity on the same session, for example when a user switches accounts.
• Identity applies to the current session. On later visits, call identify() again once the user is known.