@xylabs/pixel 5.0.83 → 5.0.86

package/README.md

@@ -15,6 +15,8 @@
 
 Event Client for xylabs ESB
 
+
+
 ## Reference
 
 **@xylabs/pixel**
@@ -23,28 +25,34 @@ Event Client for xylabs ESB
 
 ## Classes
 
-- [PixelApi](#classes/PixelApi)
-- [XyPixel](#classes/XyPixel)
-- [Referrer](#classes/Referrer)
-- [UniqueUserId](#classes/UniqueUserId)
-- [UserEventHandler](#classes/UserEventHandler)
-- [UtmFields](#classes/UtmFields)
-- [XyUserEventHandler](#classes/XyUserEventHandler)
+| Class | Description |
+| ------ | ------ |
+| [PixelApi](#classes/PixelApi) | HTTP client for sending tracking events to the XY Labs pixel API. |
+| [XyPixel](#classes/XyPixel) | Singleton pixel tracker that queues and sends user events to the XY Labs tracking API. |
+| [Referrer](#classes/Referrer) | Tracks and persists the document referrer in both session and local storage. |
+| [UniqueUserId](#classes/UniqueUserId) | Generates and persists a unique user identifier in localStorage. |
+| [UserEventHandler](#classes/UserEventHandler) | Abstract base class for handling user tracking events. |
+| [UtmFields](#classes/UtmFields) | Tracks UTM campaign parameters from query strings, persisting history in localStorage. |
+| [XyUserEventHandler](#classes/XyUserEventHandler) | Concrete event handler that sends tracking events through the XyPixel singleton. |
 
 ## Interfaces
 
-- [UserEvent](#interfaces/UserEvent)
-- [CommonFields](#interfaces/CommonFields)
-- [FunnelStartedFields](#interfaces/FunnelStartedFields)
-- [PurchaseFields](#interfaces/PurchaseFields)
-- [TestStartedFields](#interfaces/TestStartedFields)
-- [UserClickFields](#interfaces/UserClickFields)
-- [ViewContentFields](#interfaces/ViewContentFields)
-- [XyLabsTrackingEventJson](#interfaces/XyLabsTrackingEventJson)
+| Interface | Description |
+| ------ | ------ |
+| [UserEvent](#interfaces/UserEvent) | Represents a single user tracking event to be sent to the pixel API. |
+| [CommonFields](#interfaces/CommonFields) | Common fields shared across all tracking event types. |
+| [FunnelStartedFields](#interfaces/FunnelStartedFields) | Fields for a funnel-started tracking event. |
+| [PurchaseFields](#interfaces/PurchaseFields) | Fields for a purchase tracking event. |
+| [TestStartedFields](#interfaces/TestStartedFields) | Fields for a test-started tracking event (e.g. A/B test). |
+| [UserClickFields](#interfaces/UserClickFields) | Fields for a user click tracking event. |
+| [ViewContentFields](#interfaces/ViewContentFields) | Fields for a view-content tracking event. |
+| [XyLabsTrackingEventJson](#interfaces/XyLabsTrackingEventJson) | JSON structure for an XY Labs tracking event as stored or transmitted. |
 
 ## Type Aliases
 
-- [UserEventSystem](#type-aliases/UserEventSystem)
+| Type Alias | Description |
+| ------ | ------ |
+| [UserEventSystem](#type-aliases/UserEventSystem) | Parsed browser/OS/engine information from the user agent string. |
 
 ### classes
 
@@ -54,19 +62,21 @@ Event Client for xylabs ESB
 
 ***
 
+HTTP client for sending tracking events to the XY Labs pixel API.
+
 ## Constructors
 
 ### Constructor
 
 ```ts
-new PixelApi(baseUri?): PixelApi;
+new PixelApi(baseUri?: string): PixelApi;
 ```
 
 ### Parameters
 
-#### baseUri?
-
-`string` = `'prod'`
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `baseUri` | `string` | `'prod'` |
 
 ### Returns
 
@@ -77,25 +87,31 @@ new PixelApi(baseUri?): PixelApi;
 ### trackEvents()
 
 ```ts
-trackEvents(events): Promise<any>;
+trackEvents(events: UserEvent[]): Promise<any>;
 ```
 
-### Parameters
+Sends an array of user events to the tracking API.
 
-#### events
+### Parameters
 
-[`UserEvent`](#../interfaces/UserEvent)[]
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `events` | [`UserEvent`](#../interfaces/UserEvent)[] | The events to submit |
 
 ### Returns
 
 `Promise`\<`any`\>
 
+The response data from the API
+
   ### <a id="Referrer"></a>Referrer
 
 [**@xylabs/pixel**](#../README)
 
 ***
 
+Tracks and persists the document referrer in both session and local storage.
+
 ## Constructors
 
 ### Constructor
@@ -110,19 +126,10 @@ new Referrer(): Referrer;
 
 ## Properties
 
-### local
-
-```ts
-local: string;
-```
-
-***
-
-### session
-
-```ts
-session: string;
-```
+| Property | Type |
+| ------ | ------ |
+| <a id="local"></a> `local` | `string` |
+| <a id="session"></a> `session` | `string` |
 
 ## Methods
 
@@ -137,6 +144,8 @@ toJson():
   | undefined;
 ```
 
+Returns the referrer data as a JSON object, or undefined if both values are empty.
+
 ### Returns
 
   \| \{
@@ -145,12 +154,16 @@ toJson():
 \}
   \| `undefined`
 
+An object with local and session referrer strings, or undefined
+
   ### <a id="UniqueUserId"></a>UniqueUserId
 
 [**@xylabs/pixel**](#../README)
 
 ***
 
+Generates and persists a unique user identifier in localStorage.
+
 ## Constructors
 
 ### Constructor
@@ -165,11 +178,9 @@ new UniqueUserId(): UniqueUserId;
 
 ## Properties
 
-### id
-
-```ts
-id: string;
-```
+| Property | Type |
+| ------ | ------ |
+| <a id="id"></a> `id` | `string` |
 
 ## Methods
 
@@ -179,6 +190,8 @@ id: string;
 toString(): string;
 ```
 
+Returns the unique user ID as a string.
+
 ### Returns
 
 `string`
@@ -189,15 +202,17 @@ toString(): string;
 
 ***
 
+Abstract base class for handling user tracking events.
+
 ## Extended by
 
 - [`XyUserEventHandler`](#XyUserEventHandler)
 
 ## Type Parameters
 
-### TData
-
-`TData` *extends* `EmptyObject`
+| Type Parameter |
+| ------ |
+| `TData` *extends* `EmptyObject` |
 
 ## Constructors
 
@@ -216,20 +231,22 @@ new UserEventHandler<TData>(): UserEventHandler<TData>;
 ### funnelStarted()
 
 ```ts
-abstract funnelStarted<T>(fields): Promisable<void>;
+abstract funnelStarted<T>(fields: FunnelStartedFields | T): Promisable<void>;
 ```
 
-### Type Parameters
+Tracks a funnel-started event.
 
-#### T
+### Type Parameters
 
-`T` *extends* `object`
+| Type Parameter |
+| ------ |
+| `T` *extends* `object` |
 
 ### Parameters
 
-#### fields
-
-[`FunnelStartedFields`](#../interfaces/FunnelStartedFields) | `T`
+| Parameter | Type |
+| ------ | ------ |
+| `fields` | [`FunnelStartedFields`](#../interfaces/FunnelStartedFields) \| `T` |
 
 ### Returns
 
@@ -240,20 +257,22 @@ abstract funnelStarted<T>(fields): Promisable<void>;
 ### testStarted()
 
 ```ts
-abstract testStarted<T>(fields): Promisable<void>;
+abstract testStarted<T>(fields: TestStartedFields | T): Promisable<void>;
 ```
 
-### Type Parameters
+Tracks a test-started event.
 
-#### T
+### Type Parameters
 
-`T` *extends* `object`
+| Type Parameter |
+| ------ |
+| `T` *extends* `object` |
 
 ### Parameters
 
-#### fields
-
-[`TestStartedFields`](#../interfaces/TestStartedFields) | `T`
+| Parameter | Type |
+| ------ | ------ |
+| `fields` | [`TestStartedFields`](#../interfaces/TestStartedFields) \| `T` |
 
 ### Returns
 
@@ -264,20 +283,22 @@ abstract testStarted<T>(fields): Promisable<void>;
 ### userClick()
 
 ```ts
-abstract userClick<T>(fields): Promisable<void>;
+abstract userClick<T>(fields: UserClickFields | T): Promisable<void>;
 ```
 
-### Type Parameters
+Tracks a user click event.
 
-#### T
+### Type Parameters
 
-`T` *extends* `object`
+| Type Parameter |
+| ------ |
+| `T` *extends* `object` |
 
 ### Parameters
 
-#### fields
-
-[`UserClickFields`](#../interfaces/UserClickFields) | `T`
+| Parameter | Type |
+| ------ | ------ |
+| `fields` | [`UserClickFields`](#../interfaces/UserClickFields) \| `T` |
 
 ### Returns
 
@@ -288,20 +309,22 @@ abstract userClick<T>(fields): Promisable<void>;
 ### viewContent()
 
 ```ts
-abstract viewContent<T>(fields): Promisable<void>;
+abstract viewContent<T>(fields: T | ViewContentFields): Promisable<void>;
 ```
 
-### Type Parameters
+Tracks a view-content event.
 
-#### T
+### Type Parameters
 
-`T` *extends* `object`
+| Type Parameter |
+| ------ |
+| `T` *extends* `object` |
 
 ### Parameters
 
-#### fields
-
-`T` | [`ViewContentFields`](#../interfaces/ViewContentFields)
+| Parameter | Type |
+| ------ | ------ |
+| `fields` | `T` \| [`ViewContentFields`](#../interfaces/ViewContentFields) |
 
 ### Returns
 
@@ -313,6 +336,8 @@ abstract viewContent<T>(fields): Promisable<void>;
 
 ***
 
+Tracks UTM campaign parameters from query strings, persisting history in localStorage.
+
 ## Constructors
 
 ### Constructor
@@ -327,11 +352,9 @@ new UtmFields(): UtmFields;
 
 ## Properties
 
-### fields
-
-```ts
-fields: Record<string, string>[] = [];
-```
+| Property | Type | Default value |
+| ------ | ------ | ------ |
+| <a id="fields"></a> `fields` | `Record`\<`string`, `string`\>[] | `[]` |
 
 ## Methods
 
@@ -341,10 +364,14 @@ fields: Record<string, string>[] = [];
 getUtmRecord(): Record<string, string> | null;
 ```
 
+Parses UTM parameters from the current URL query string.
+
 ### Returns
 
 `Record`\<`string`, `string`\> \| `null`
 
+A record of UTM key-value pairs, or null if none are present
+
 ***
 
 ### toString()
@@ -353,6 +380,8 @@ getUtmRecord(): Record<string, string> | null;
 toString(): string;
 ```
 
+Returns the UTM fields history as a JSON string.
+
 ### Returns
 
 `string`
@@ -365,71 +394,33 @@ toString(): string;
 update(): Record<string, string>[];
 ```
 
+Checks the query string for new UTM values and appends them to the history if changed.
+
 ### Returns
 
 `Record`\<`string`, `string`\>[]
 
+The current UTM fields array, or undefined if empty
+
   ### <a id="XyPixel"></a>XyPixel
 
 [**@xylabs/pixel**](#../README)
 
 ***
 
-## Properties
-
-### api
-
-```ts
-static api: PixelApi;
-```
-
-***
-
-### cid
-
-```ts
-cid: string;
-```
-
-***
-
-### email?
+Singleton pixel tracker that queues and sends user events to the XY Labs tracking API.
 
-```ts
-optional email: string;
-```
-
-***
-
-### email\_hash?
-
-```ts
-optional email_hash: string | null;
-```
-
-***
-
-### exids?
-
-```ts
-optional exids: ExIds;
-```
-
-***
-
-### pixelId?
-
-```ts
-optional pixelId: string;
-```
-
-***
+## Properties
 
-### queue
-
-```ts
-queue: UserEvent[] = [];
-```
+| Property | Modifier | Type | Default value |
+| ------ | ------ | ------ | ------ |
+| <a id="api"></a> `api` | `static` | [`PixelApi`](#PixelApi) | `undefined` |
+| <a id="cid"></a> `cid` | `public` | `string` | `undefined` |
+| <a id="email"></a> `email?` | `public` | `string` | `undefined` |
+| <a id="email_hash"></a> `email_hash?` | `public` | `string` \| `null` | `undefined` |
+| <a id="exids"></a> `exids?` | `public` | `ExIds` | `undefined` |
+| <a id="pixelid"></a> `pixelId?` | `public` | `string` | `undefined` |
+| <a id="queue"></a> `queue` | `public` | [`UserEvent`](#../interfaces/UserEvent)[] | `[]` |
 
 ## Accessors
 
@@ -441,6 +432,8 @@ queue: UserEvent[] = [];
 get static instance(): XyPixel;
 ```
 
+Returns the singleton XyPixel instance, throwing if not yet initialized.
+
 #### Returns
 
 `XyPixel`
@@ -450,32 +443,38 @@ get static instance(): XyPixel;
 ### init()
 
 ```ts
-static init(pixelId): XyPixel;
+static init(pixelId: string): XyPixel;
 ```
 
-### Parameters
+Initializes the XyPixel singleton with the given pixel ID.
 
-#### pixelId
+### Parameters
 
-`string`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `pixelId` | `string` | The pixel identifier for this tracking instance |
 
 ### Returns
 
 `XyPixel`
 
+The newly created XyPixel instance
+
 ***
 
 ### selectApi()
 
 ```ts
-static selectApi(api): void;
+static selectApi(api: PixelApi): void;
 ```
 
-### Parameters
+Replaces the default PixelApi instance used for sending events.
 
-#### api
+### Parameters
 
-[`PixelApi`](#PixelApi)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `api` | [`PixelApi`](#PixelApi) | The PixelApi instance to use |
 
 ### Returns
 
@@ -486,14 +485,16 @@ static selectApi(api): void;
 ### identify()
 
 ```ts
-identify(email?): void;
+identify(email?: string): void;
 ```
 
-### Parameters
+Associates an email address with this pixel instance, hashing it for privacy.
 
-#### email?
+### Parameters
 
-`string`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `email?` | `string` | The email address to identify the user with |
 
 ### Returns
 
@@ -505,30 +506,26 @@ identify(email?): void;
 
 ```ts
 send<T>(
-   event, 
-   fields?, 
-eventId?): Promise<void>;
+   event: string, 
+   fields?: T, 
+eventId?: string): Promise<void>;
 ```
 
-### Type Parameters
+Queues a tracking event and attempts to flush the queue to the API.
 
-#### T
+### Type Parameters
 
-`T` *extends* `Record`\<`string`, `unknown`\>
+| Type Parameter |
+| ------ |
+| `T` *extends* `Record`\<`string`, `unknown`\> |
 
 ### Parameters
 
-#### event
-
-`string`
-
-#### fields?
-
-`T`
-
-#### eventId?
-
-`string`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `event` | `string` | The event name |
+| `fields?` | `T` | Optional event-specific fields |
+| `eventId?` | `string` | Optional unique event identifier |
 
 ### Returns
 
@@ -540,15 +537,17 @@ eventId?): Promise<void>;
 
 ***
 
+Concrete event handler that sends tracking events through the XyPixel singleton.
+
 ## Extends
 
 - [`UserEventHandler`](#UserEventHandler)\<`T`\>
 
 ## Type Parameters
 
-### T
-
-`T` *extends* `EmptyObject` = `EmptyObject`
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* `EmptyObject` | `EmptyObject` |
 
 ## Constructors
 
@@ -571,14 +570,16 @@ new XyUserEventHandler<T>(): XyUserEventHandler<T>;
 ### funnelStarted()
 
 ```ts
-funnelStarted(fields): Promise<void>;
+funnelStarted(fields: FunnelStartedFields | T): Promise<void>;
 ```
 
-### Parameters
+Sends a funnel-started event via the pixel API.
 
-#### fields
+### Parameters
 
-[`FunnelStartedFields`](#../interfaces/FunnelStartedFields) | `T`
+| Parameter | Type |
+| ------ | ------ |
+| `fields` | [`FunnelStartedFields`](#../interfaces/FunnelStartedFields) \| `T` |
 
 ### Returns
 
@@ -593,14 +594,16 @@ funnelStarted(fields): Promise<void>;
 ### purchase()
 
 ```ts
-purchase(fields): Promise<void>;
+purchase(fields: PurchaseFields | T): Promise<void>;
 ```
 
-### Parameters
+Sends a purchase event via the pixel API.
 
-#### fields
+### Parameters
 
-[`PurchaseFields`](#../interfaces/PurchaseFields) | `T`
+| Parameter | Type |
+| ------ | ------ |
+| `fields` | [`PurchaseFields`](#../interfaces/PurchaseFields) \| `T` |
 
 ### Returns
 
@@ -611,14 +614,16 @@ purchase(fields): Promise<void>;
 ### testStarted()
 
 ```ts
-testStarted(fields): Promise<void>;
+testStarted(fields: TestStartedFields | T): Promise<void>;
 ```
 
-### Parameters
+Sends a test-started event via the pixel API.
 
-#### fields
+### Parameters
 
-[`TestStartedFields`](#../interfaces/TestStartedFields) | `T`
+| Parameter | Type |
+| ------ | ------ |
+| `fields` | [`TestStartedFields`](#../interfaces/TestStartedFields) \| `T` |
 
 ### Returns
 
@@ -633,14 +638,16 @@ testStarted(fields): Promise<void>;
 ### userClick()
 
 ```ts
-userClick(fields): Promise<void>;
+userClick(fields: UserClickFields | T): Promise<void>;
 ```
 
-### Parameters
+Sends a user click event via the pixel API.
 
-#### fields
+### Parameters
 
-[`UserClickFields`](#../interfaces/UserClickFields) | `T`
+| Parameter | Type |
+| ------ | ------ |
+| `fields` | [`UserClickFields`](#../interfaces/UserClickFields) \| `T` |
 
 ### Returns
 
@@ -655,14 +662,16 @@ userClick(fields): Promise<void>;
 ### viewContent()
 
 ```ts
-viewContent(fields): Promise<void>;
+viewContent(fields: ViewContentFields | T): Promise<void>;
 ```
 
-### Parameters
+Sends a view-content event via the pixel API.
 
-#### fields
+### Parameters
 
-[`ViewContentFields`](#../interfaces/ViewContentFields) | `T`
+| Parameter | Type |
+| ------ | ------ |
+| `fields` | [`ViewContentFields`](#../interfaces/ViewContentFields) \| `T` |
 
 ### Returns
 
@@ -680,6 +689,8 @@ viewContent(fields): Promise<void>;
 
 ***
 
+Common fields shared across all tracking event types.
+
 ## Extended by
 
 - [`FunnelStartedFields`](#FunnelStartedFields)
@@ -690,19 +701,10 @@ viewContent(fields): Promise<void>;
 
 ## Properties
 
-### funnel?
-
-```ts
-optional funnel: string;
-```
-
-***
-
-### testData?
-
-```ts
-optional testData: string;
-```
+| Property | Type |
+| ------ | ------ |
+| <a id="funnel"></a> `funnel?` | `string` |
+| <a id="testdata"></a> `testData?` | `string` |
 
   ### <a id="FunnelStartedFields"></a>FunnelStartedFields
 
@@ -710,41 +712,19 @@ optional testData: string;
 
 ***
 
+Fields for a funnel-started tracking event.
+
 ## Extends
 
 - [`CommonFields`](#CommonFields)
 
 ## Properties
 
-### funnel?
-
-```ts
-optional funnel: string;
-```
-
-### Inherited from
-
-[`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel)
-
-***
-
-### testData?
-
-```ts
-optional testData: string;
-```
-
-### Inherited from
-
-[`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata)
-
-***
-
-### name
-
-```ts
-name: string;
-```
+| Property | Type | Inherited from |
+| ------ | ------ | ------ |
+| <a id="funnel"></a> `funnel?` | `string` | [`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel) |
+| <a id="testdata"></a> `testData?` | `string` | [`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata) |
+| <a id="name"></a> `name` | `string` | - |
 
   ### <a id="PurchaseFields"></a>PurchaseFields
 
@@ -752,65 +732,22 @@ name: string;
 
 ***
 
+Fields for a purchase tracking event.
+
 ## Extends
 
 - [`CommonFields`](#CommonFields)
 
 ## Properties
 
-### funnel?
-
-```ts
-optional funnel: string;
-```
-
-### Inherited from
-
-[`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel)
-
-***
-
-### testData?
-
-```ts
-optional testData: string;
-```
-
-### Inherited from
-
-[`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata)
-
-***
-
-### id
-
-```ts
-id: string;
-```
-
-***
-
-### name?
-
-```ts
-optional name: string;
-```
-
-***
-
-### price?
-
-```ts
-optional price: number;
-```
-
-***
-
-### value?
-
-```ts
-optional value: number;
-```
+| Property | Type | Inherited from |
+| ------ | ------ | ------ |
+| <a id="funnel"></a> `funnel?` | `string` | [`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel) |
+| <a id="testdata"></a> `testData?` | `string` | [`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata) |
+| <a id="id"></a> `id` | `string` | - |
+| <a id="name"></a> `name?` | `string` | - |
+| <a id="price"></a> `price?` | `number` | - |
+| <a id="value"></a> `value?` | `number` | - |
 
   ### <a id="TestStartedFields"></a>TestStartedFields
 
@@ -818,41 +755,19 @@ optional value: number;
 
 ***
 
+Fields for a test-started tracking event (e.g. A/B test).
+
 ## Extends
 
 - [`CommonFields`](#CommonFields)
 
 ## Properties
 
-### funnel?
-
-```ts
-optional funnel: string;
-```
-
-### Inherited from
-
-[`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel)
-
-***
-
-### testData?
-
-```ts
-optional testData: string;
-```
-
-### Inherited from
-
-[`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata)
-
-***
-
-### name
-
-```ts
-name: string;
-```
+| Property | Type | Inherited from |
+| ------ | ------ | ------ |
+| <a id="funnel"></a> `funnel?` | `string` | [`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel) |
+| <a id="testdata"></a> `testData?` | `string` | [`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata) |
+| <a id="name"></a> `name` | `string` | - |
 
   ### <a id="UserClickFields"></a>UserClickFields
 
@@ -860,65 +775,22 @@ name: string;
 
 ***
 
+Fields for a user click tracking event.
+
 ## Extends
 
 - [`CommonFields`](#CommonFields)
 
 ## Properties
 
-### funnel?
-
-```ts
-optional funnel: string;
-```
-
-### Inherited from
-
-[`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel)
-
-***
-
-### testData?
-
-```ts
-optional testData: string;
-```
-
-### Inherited from
-
-[`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata)
-
-***
-
-### elementName
-
-```ts
-elementName: string;
-```
-
-***
-
-### elementType
-
-```ts
-elementType: string;
-```
-
-***
-
-### intent?
-
-```ts
-optional intent: string;
-```
-
-***
-
-### placement?
-
-```ts
-optional placement: string;
-```
+| Property | Type | Inherited from |
+| ------ | ------ | ------ |
+| <a id="funnel"></a> `funnel?` | `string` | [`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel) |
+| <a id="testdata"></a> `testData?` | `string` | [`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata) |
+| <a id="elementname"></a> `elementName` | `string` | - |
+| <a id="elementtype"></a> `elementType` | `string` | - |
+| <a id="intent"></a> `intent?` | `string` | - |
+| <a id="placement"></a> `placement?` | `string` | - |
 
   ### <a id="UserEvent"></a>UserEvent
 
@@ -926,153 +798,31 @@ optional placement: string;
 
 ***
 
-## Properties
-
-### cid
-
-```ts
-cid: string;
-```
-
-***
-
-### create\_time?
-
-```ts
-optional create_time: number;
-```
-
-***
-
-### email?
+Represents a single user tracking event to be sent to the pixel API.
 
-```ts
-optional email: string;
-```
-
-***
-
-### email\_hash?
-
-```ts
-optional email_hash: string;
-```
-
-***
-
-### event?
-
-```ts
-optional event: string;
-```
-
-***
-
-### event\_id?
-
-```ts
-optional event_id: string;
-```
-
-***
-
-### exids?
-
-```ts
-optional exids: ExIds;
-```
-
-***
-
-### fields?
-
-```ts
-optional fields: Record<string, unknown>;
-```
-
-***
-
-### host?
-
-```ts
-optional host: string;
-```
-
-***
-
-### pathname?
-
-```ts
-optional pathname: string;
-```
-
-***
-
-### pixel?
-
-```ts
-optional pixel: string;
-```
-
-***
-
-### receive\_time?
-
-```ts
-optional receive_time: number;
-```
-
-***
-
-### referrer?
-
-```ts
-optional referrer: object;
-```
-
-### local
-
-```ts
-local: string;
-```
-
-### session
-
-```ts
-session: string;
-```
-
-***
-
-### rid?
-
-```ts
-optional rid: string;
-```
-
-***
-
-### system?
-
-```ts
-optional system: ParsedResult;
-```
-
-***
-
-### uid?
-
-```ts
-optional uid: string;
-```
-
-***
-
-### utm?
+## Properties
 
-```ts
-optional utm: Record<string, string>[] | Record<string, string[]>;
-```
+| Property | Type |
+| ------ | ------ |
+| <a id="cid"></a> `cid` | `string` |
+| <a id="create_time"></a> `create_time?` | `number` |
+| <a id="email"></a> `email?` | `string` |
+| <a id="email_hash"></a> `email_hash?` | `string` |
+| <a id="event"></a> `event?` | `string` |
+| <a id="event_id"></a> `event_id?` | `string` |
+| <a id="exids"></a> `exids?` | `ExIds` |
+| <a id="fields"></a> `fields?` | `Record`\<`string`, `unknown`\> |
+| <a id="host"></a> `host?` | `string` |
+| <a id="pathname"></a> `pathname?` | `string` |
+| <a id="pixel"></a> `pixel?` | `string` |
+| <a id="receive_time"></a> `receive_time?` | `number` |
+| <a id="referrer"></a> `referrer?` | \{ `local`: `string`; `session`: `string`; \} |
+| `referrer.local` | `string` |
+| `referrer.session` | `string` |
+| <a id="rid"></a> `rid?` | `string` |
+| <a id="system"></a> `system?` | `ParsedResult` |
+| <a id="uid"></a> `uid?` | `string` |
+| <a id="utm"></a> `utm?` | `Record`\<`string`, `string`\>[] \| `Record`\<`string`, `string`[]\> |
 
   ### <a id="ViewContentFields"></a>ViewContentFields
 
@@ -1080,49 +830,20 @@ optional utm: Record<string, string>[] | Record<string, string[]>;
 
 ***
 
+Fields for a view-content tracking event.
+
 ## Extends
 
 - [`CommonFields`](#CommonFields)
 
 ## Properties
 
-### funnel?
-
-```ts
-optional funnel: string;
-```
-
-### Inherited from
-
-[`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel)
-
-***
-
-### testData?
-
-```ts
-optional testData: string;
-```
-
-### Inherited from
-
-[`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata)
-
-***
-
-### name
-
-```ts
-name: string;
-```
-
-***
-
-### path
-
-```ts
-path: string;
-```
+| Property | Type | Inherited from |
+| ------ | ------ | ------ |
+| <a id="funnel"></a> `funnel?` | `string` | [`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel) |
+| <a id="testdata"></a> `testData?` | `string` | [`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata) |
+| <a id="name"></a> `name` | `string` | - |
+| <a id="path"></a> `path` | `string` | - |
 
   ### <a id="XyLabsTrackingEventJson"></a>XyLabsTrackingEventJson
 
@@ -1130,149 +851,30 @@ path: string;
 
 ***
 
-## Properties
-
-### cid
-
-```ts
-cid: string;
-```
-
-***
-
-### create\_time?
-
-```ts
-optional create_time: number;
-```
-
-***
-
-### email?
-
-```ts
-optional email: string;
-```
-
-***
-
-### email\_hash?
-
-```ts
-optional email_hash: string;
-```
-
-***
-
-### event?
-
-```ts
-optional event: string;
-```
-
-***
-
-### event\_id?
-
-```ts
-optional event_id: string;
-```
-
-***
-
-### exids?
-
-```ts
-optional exids: Record<string, string>;
-```
-
-***
-
-### fields?
-
-```ts
-optional fields: Record<string, unknown>;
-```
+JSON structure for an XY Labs tracking event as stored or transmitted.
 
-***
-
-### host?
-
-```ts
-optional host: string;
-```
-
-***
-
-### ip?
-
-```ts
-optional ip: string;
-```
-
-***
-
-### pathname?
-
-```ts
-optional pathname: string;
-```
-
-***
-
-### pixel?
-
-```ts
-optional pixel: string;
-```
-
-***
-
-### receive\_time?
-
-```ts
-optional receive_time: number;
-```
-
-***
-
-### rid?
-
-```ts
-optional rid: string;
-```
-
-***
-
-### system?
-
-```ts
-optional system: unknown;
-```
-
-***
-
-### ua?
-
-```ts
-optional ua: string;
-```
-
-***
-
-### uid?
-
-```ts
-optional uid: string;
-```
-
-***
+## Properties
 
-### utm?
-
-```ts
-optional utm: Record<string, string>[] | Record<string, string[]>;
-```
+| Property | Type |
+| ------ | ------ |
+| <a id="cid"></a> `cid` | `string` |
+| <a id="create_time"></a> `create_time?` | `number` |
+| <a id="email"></a> `email?` | `string` |
+| <a id="email_hash"></a> `email_hash?` | `string` |
+| <a id="event"></a> `event?` | `string` |
+| <a id="event_id"></a> `event_id?` | `string` |
+| <a id="exids"></a> `exids?` | `Record`\<`string`, `string`\> |
+| <a id="fields"></a> `fields?` | `Record`\<`string`, `unknown`\> |
+| <a id="host"></a> `host?` | `string` |
+| <a id="ip"></a> `ip?` | `string` |
+| <a id="pathname"></a> `pathname?` | `string` |
+| <a id="pixel"></a> `pixel?` | `string` |
+| <a id="receive_time"></a> `receive_time?` | `number` |
+| <a id="rid"></a> `rid?` | `string` |
+| <a id="system"></a> `system?` | `unknown` |
+| <a id="ua"></a> `ua?` | `string` |
+| <a id="uid"></a> `uid?` | `string` |
+| <a id="utm"></a> `utm?` | `Record`\<`string`, `string`\>[] \| `Record`\<`string`, `string`[]\> |
 
 ### type-aliases
 
@@ -1286,6 +888,8 @@ optional utm: Record<string, string>[] | Record<string, string[]>;
 type UserEventSystem = Bowser.Parser.ParsedResult;
 ```
 
+Parsed browser/OS/engine information from the user agent string.
+
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)