Skip to content

js-bao-wss-client


js-bao-wss-client / AnalyticsEventInput

Interface: AnalyticsEventInput ​

A single analytics event passed to logEvent. Only action and user_ulid are required — pass ANALYTICS_UNAUTHENTICATED_USER as user_ulid for pre-auth events. Omitted context fields (feature, plan, tenant, device/OS/browser details) are filled in automatically from the client's environment before the event is sent.

Properties ​

action ​

action: string


app_version? ​

optional app_version?: string


browser_name? ​

optional browser_name?: string


browser_version? ​

optional browser_version?: string


context_json? ​

optional context_json?: string | Record<string, unknown> | null


device_type? ​

optional device_type?: string


feature? ​

optional feature?: string


os_name? ​

optional os_name?: string


os_version? ​

optional os_version?: string


plan? ​

optional plan?: string


route? ​

optional route?: string


tenant_id? ​

optional tenant_id?: string


user_created_at_epoch_s? ​

optional user_created_at_epoch_s?: number

Deprecated ​

Ignored. The server records when the user joined the app; any value passed here is dropped before the event is sent.


user_ulid ​

user_ulid: string

Documentation validated against js-bao-wss-client 3.4.0 · js-bao 0.11.0 · primitive-admin 1.0.62 · primitive-app 3.1.0 — 2026-09-30