diff --git a/docs/analytics.action.md b/docs/analytics.action.md index 2a0e307c..d00da52b 100644 --- a/docs/analytics.action.md +++ b/docs/analytics.action.md @@ -6,7 +6,7 @@ The action types accepted by the Analytics Events API. -Signature: +**Signature:** ```typescript export declare type Action = `C_${string}` | `c_${string}` | 'ADD_TO_CART' | 'ALL_TAB_NAVIGATION' | 'APPLY' | 'AUTO_COMPLETE_SELECTION' | 'BACKWARD_PAGINATE' | 'BOOK' | 'BRAND_ICON' | 'CASE_START' | 'CASE_SUBMITTED' | 'CHAT_IMPRESSION' | 'CHAT_LINK_CLICK' | 'CHAT_RESPONSE' | 'COLLAPSE' | 'CTA_CLICK' | 'DRIVING_DIRECTIONS' | 'EVENT' | 'EXPAND' | 'FEATURED_MESSAGE' | 'FILTERING_WITHIN_SECTION' | 'FORWARD_PAGINATE' | 'HEADER_LINKS' | 'ITEM_IN_LIST' | 'MAP_CARD' | 'MAP_PIN' | 'MENU' | 'MESSAGE' | 'ORDER' | 'PAGE_VIEW' | 'PAGINATE' | 'POST' | 'PRESET_PROMPT' | 'PRODUCT' | 'PROFILE' | 'QUESTION_FOCUS' | 'QUESTION_SUBMIT' | 'REMOVED_FILTER' | 'REVIEW' | 'SCROLL_TO_BOTTOM_OF_PAGE' | 'SEARCH_BAR_IMPRESSION' | 'SEARCH_CLEAR_BUTTON' | 'TAP_TO_CALL' | 'THUMBS_DOWN' | 'THUMBS_UP' | 'TICKET_URL' | 'TITLE' | 'VERTICAL_TAB_NAVIGATION' | 'VERTICAL_VIEW_ALL' | 'VOICE_START' | 'VOICE_STOP' | 'WEBSITE'; diff --git a/docs/analytics.analytics.md b/docs/analytics.analytics.md index 3671bbf5..bff56ec4 100644 --- a/docs/analytics.analytics.md +++ b/docs/analytics.analytics.md @@ -6,7 +6,7 @@ The Yext Analytics Events SDK. Returns an AnalyticsEventService given an AnalyticsConfig. -Signature: +**Signature:** ```typescript export declare function analytics(config: AnalyticsConfig): AnalyticsEventService; @@ -18,7 +18,7 @@ export declare function analytics(config: AnalyticsConfig): AnalyticsEventServic | --- | --- | --- | | config | [AnalyticsConfig](./analytics.analyticsconfig.md) | | -Returns: +**Returns:** [AnalyticsEventService](./analytics.analyticseventservice.md) diff --git a/docs/analytics.analyticsconfig.bearer.md b/docs/analytics.analyticsconfig.bearer.md index cfde433d..a96cb4c8 100644 --- a/docs/analytics.analyticsconfig.bearer.md +++ b/docs/analytics.analyticsconfig.bearer.md @@ -6,7 +6,7 @@ The bearer token for accessing the Analytics Events API. Only one of key or bearer should be set. -Signature: +**Signature:** ```typescript bearer?: string; diff --git a/docs/analytics.analyticsconfig.env.md b/docs/analytics.analyticsconfig.env.md index c1ec8401..496e06b8 100644 --- a/docs/analytics.analyticsconfig.env.md +++ b/docs/analytics.analyticsconfig.env.md @@ -6,7 +6,7 @@ The Yext environment to send requests to. Defaults to 'PRODUCTION'. -Signature: +**Signature:** ```typescript env?: Environment; diff --git a/docs/analytics.analyticsconfig.forcefetch.md b/docs/analytics.analyticsconfig.forcefetch.md index f15fa47d..fdfca1da 100644 --- a/docs/analytics.analyticsconfig.forcefetch.md +++ b/docs/analytics.analyticsconfig.forcefetch.md @@ -6,7 +6,7 @@ Used to force sending the request with fetch even if the browser does not support fetch with the keepalive flag (like Firefox). If the browser does support it, fetch is used by default. -Signature: +**Signature:** ```typescript forceFetch?: boolean; diff --git a/docs/analytics.analyticsconfig.key.md b/docs/analytics.analyticsconfig.key.md index f39a6486..ad2f8dbf 100644 --- a/docs/analytics.analyticsconfig.key.md +++ b/docs/analytics.analyticsconfig.key.md @@ -6,7 +6,7 @@ The API Key or OAuth for accessing the Analytics Events API Only one of key or bearer should be set. -Signature: +**Signature:** ```typescript key?: string; diff --git a/docs/analytics.analyticsconfig.md b/docs/analytics.analyticsconfig.md index ea0d9221..2b9d6f6a 100644 --- a/docs/analytics.analyticsconfig.md +++ b/docs/analytics.analyticsconfig.md @@ -6,7 +6,7 @@ The main configuration options for Analytics Events. -Signature: +**Signature:** ```typescript export interface AnalyticsConfig @@ -14,12 +14,12 @@ export interface AnalyticsConfig ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [bearer?](./analytics.analyticsconfig.bearer.md) | string | (Optional) The bearer token for accessing the Analytics Events API. Only one of key or bearer should be set. | -| [env?](./analytics.analyticsconfig.env.md) | [Environment](./analytics.environment.md) | (Optional) The Yext environment to send requests to. Defaults to 'PRODUCTION'. | -| [forceFetch?](./analytics.analyticsconfig.forcefetch.md) | boolean | (Optional) Used to force sending the request with fetch even if the browser does not support fetch with the keepalive flag (like Firefox). If the browser does support it, fetch is used by default. | -| [key?](./analytics.analyticsconfig.key.md) | string | (Optional) The API Key or OAuth for accessing the Analytics Events API Only one of key or bearer should be set. | -| [region?](./analytics.analyticsconfig.region.md) | [Region](./analytics.region.md) | (Optional) The region to send requests to. Defaults to 'US'. | -| [sessionTrackingEnabled?](./analytics.analyticsconfig.sessiontrackingenabled.md) | boolean | (Optional) Whether to enable session tracking for analytics events. Defaults to true for both environments. If set to false, sessionId will automatically be set to undefined in the event payload. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [bearer?](./analytics.analyticsconfig.bearer.md) | | string | _(Optional)_ The bearer token for accessing the Analytics Events API. Only one of key or bearer should be set. | +| [env?](./analytics.analyticsconfig.env.md) | | [Environment](./analytics.environment.md) | _(Optional)_ The Yext environment to send requests to. Defaults to 'PRODUCTION'. | +| [forceFetch?](./analytics.analyticsconfig.forcefetch.md) | | boolean | _(Optional)_ Used to force sending the request with fetch even if the browser does not support fetch with the keepalive flag (like Firefox). If the browser does support it, fetch is used by default. | +| [key?](./analytics.analyticsconfig.key.md) | | string | _(Optional)_ The API Key or OAuth for accessing the Analytics Events API Only one of key or bearer should be set. | +| [region?](./analytics.analyticsconfig.region.md) | | [Region](./analytics.region.md) | _(Optional)_ The region to send requests to. Defaults to 'US'. | +| [sessionTrackingEnabled?](./analytics.analyticsconfig.sessiontrackingenabled.md) | | boolean | _(Optional)_ Whether to enable session tracking for analytics events. Defaults to true for both environments. If set to false, sessionId will automatically be set to undefined in the event payload. | diff --git a/docs/analytics.analyticsconfig.region.md b/docs/analytics.analyticsconfig.region.md index 31b18c5d..f92c9916 100644 --- a/docs/analytics.analyticsconfig.region.md +++ b/docs/analytics.analyticsconfig.region.md @@ -6,7 +6,7 @@ The region to send requests to. Defaults to 'US'. -Signature: +**Signature:** ```typescript region?: Region; diff --git a/docs/analytics.analyticsconfig.sessiontrackingenabled.md b/docs/analytics.analyticsconfig.sessiontrackingenabled.md index b436e5ff..23182168 100644 --- a/docs/analytics.analyticsconfig.sessiontrackingenabled.md +++ b/docs/analytics.analyticsconfig.sessiontrackingenabled.md @@ -6,7 +6,7 @@ Whether to enable session tracking for analytics events. Defaults to true for both environments. If set to false, sessionId will automatically be set to undefined in the event payload. -Signature: +**Signature:** ```typescript sessionTrackingEnabled?: boolean; diff --git a/docs/analytics.analyticseventservice.md b/docs/analytics.analyticseventservice.md index 65bf8ee5..8a99df4d 100644 --- a/docs/analytics.analyticseventservice.md +++ b/docs/analytics.analyticseventservice.md @@ -6,7 +6,7 @@ A service for reporting Yext analytics events -Signature: +**Signature:** ```typescript export interface AnalyticsEventService diff --git a/docs/analytics.analyticseventservice.report.md b/docs/analytics.analyticseventservice.report.md index 7f4ee944..94c95b27 100644 --- a/docs/analytics.analyticseventservice.report.md +++ b/docs/analytics.analyticseventservice.report.md @@ -6,7 +6,7 @@ Reports an analytics event. Operand will throw an error if the request fails. The request will default to being sent via fetch, with keepalive set to true, if supported by the browser, and a Promise of an EventAPIResponse will be returned. Otherwise, the request will be sent via the Beacon API, unless the forceFetch flag is toggled, and a boolean will be returned. -Signature: +**Signature:** ```typescript report(payload?: PartialPayload): Promise; @@ -16,9 +16,9 @@ report(payload?: PartialPayload): Promise; | Parameter | Type | Description | | --- | --- | --- | -| payload | [PartialPayload](./analytics.partialpayload.md) | desired values to be applied. The new payload will override any overlapping values. | +| payload | [PartialPayload](./analytics.partialpayload.md) | _(Optional)_ desired values to be applied. The new payload will override any overlapping values. | -Returns: +**Returns:** Promise<string> diff --git a/docs/analytics.analyticseventservice.with.md b/docs/analytics.analyticseventservice.with.md index a7af5107..c1c709ed 100644 --- a/docs/analytics.analyticseventservice.with.md +++ b/docs/analytics.analyticseventservice.with.md @@ -6,7 +6,7 @@ Creates a new AnalyticsEventService with the following values defined as the default when making a report. -Signature: +**Signature:** ```typescript with(payload: EventPayload): AnalyticsEventService; @@ -18,7 +18,7 @@ with(payload: EventPayload): AnalyticsEventService; | --- | --- | --- | | payload | [EventPayload](./analytics.eventpayload.md) | desired values to be applied. The new payload will override any overlapping values. | -Returns: +**Returns:** [AnalyticsEventService](./analytics.analyticseventservice.md) diff --git a/docs/analytics.enumorstring.md b/docs/analytics.enumorstring.md index c8fa9aec..46723964 100644 --- a/docs/analytics.enumorstring.md +++ b/docs/analytics.enumorstring.md @@ -6,7 +6,7 @@ A TypeScript utility type which creates a union of an enum member and its string representation. -Signature: +**Signature:** ```typescript export declare type EnumOrString = T | `${T}`; diff --git a/docs/analytics.environment.md b/docs/analytics.environment.md index 72db7d53..a20007e2 100644 --- a/docs/analytics.environment.md +++ b/docs/analytics.environment.md @@ -6,12 +6,12 @@ The Yext Environments -Signature: +**Signature:** ```typescript export declare type Environment = EnumOrString; ``` -References: [EnumOrString](./analytics.enumorstring.md), [EnvironmentEnum](./analytics.environmentenum.md) +**References:** [EnumOrString](./analytics.enumorstring.md), [EnvironmentEnum](./analytics.environmentenum.md) ## Remarks diff --git a/docs/analytics.environmentenum.md b/docs/analytics.environmentenum.md index cb223271..f7e70792 100644 --- a/docs/analytics.environmentenum.md +++ b/docs/analytics.environmentenum.md @@ -6,7 +6,7 @@ An enum for the Yext Environments -Signature: +**Signature:** ```typescript export declare enum EnvironmentEnum diff --git a/docs/analytics.eventpayload.action.md b/docs/analytics.eventpayload.action.md index 808acf01..35541f27 100644 --- a/docs/analytics.eventpayload.action.md +++ b/docs/analytics.eventpayload.action.md @@ -6,7 +6,7 @@ The user action which caused the event, e.g. ADD\_TO\_CART, THUMBS\_UP, C\_CUSTOM\_ACTION -Signature: +**Signature:** ```typescript action: Action; diff --git a/docs/analytics.eventpayload.authorization.md b/docs/analytics.eventpayload.authorization.md index ec85076f..1e272db4 100644 --- a/docs/analytics.eventpayload.authorization.md +++ b/docs/analytics.eventpayload.authorization.md @@ -6,7 +6,7 @@ The authorization token for the request. This will be setup from the Key or Bearer in the config. -Signature: +**Signature:** ```typescript authorization?: string; diff --git a/docs/analytics.eventpayload.bot.md b/docs/analytics.eventpayload.bot.md index 3ad50b18..b0287341 100644 --- a/docs/analytics.eventpayload.bot.md +++ b/docs/analytics.eventpayload.bot.md @@ -6,7 +6,7 @@ Whether the event is the result of bot activity. -Signature: +**Signature:** ```typescript bot?: boolean; diff --git a/docs/analytics.eventpayload.browseragent.md b/docs/analytics.eventpayload.browseragent.md index e424fdbd..bd96e455 100644 --- a/docs/analytics.eventpayload.browseragent.md +++ b/docs/analytics.eventpayload.browseragent.md @@ -6,7 +6,7 @@ Information about the visitors device and browser. -Signature: +**Signature:** ```typescript browserAgent?: { diff --git a/docs/analytics.eventpayload.chat.md b/docs/analytics.eventpayload.chat.md index 1e1f48dd..6faf21af 100644 --- a/docs/analytics.eventpayload.chat.md +++ b/docs/analytics.eventpayload.chat.md @@ -6,7 +6,7 @@ Fields specific to reporting Chat Analytics Events -Signature: +**Signature:** ```typescript chat?: { diff --git a/docs/analytics.eventpayload.clientsdk.md b/docs/analytics.eventpayload.clientsdk.md index 42dcae79..95aff9b4 100644 --- a/docs/analytics.eventpayload.clientsdk.md +++ b/docs/analytics.eventpayload.clientsdk.md @@ -6,7 +6,7 @@ For the Yext client SDKs involved in the event, this is an object mapping the names of those SDKs to the version labels of those SDKs. -Signature: +**Signature:** ```typescript clientSdk?: Record; diff --git a/docs/analytics.eventpayload.count.md b/docs/analytics.eventpayload.count.md index 5c31cba3..4c1588ab 100644 --- a/docs/analytics.eventpayload.count.md +++ b/docs/analytics.eventpayload.count.md @@ -6,7 +6,7 @@ When the record summarizes multiple events, the number of events the record represents. The event is treated as if it is duplicated this many times. -Signature: +**Signature:** ```typescript count?: number; diff --git a/docs/analytics.eventpayload.customtags.md b/docs/analytics.eventpayload.customtags.md index 659ad8e9..78547a86 100644 --- a/docs/analytics.eventpayload.customtags.md +++ b/docs/analytics.eventpayload.customtags.md @@ -6,7 +6,7 @@ Up to 10 pairs matching custom string keys to string values to associate with the event. Keys are case-insensitive; values are case-sensitive. -Signature: +**Signature:** ```typescript customTags?: Record; diff --git a/docs/analytics.eventpayload.customvalues.md b/docs/analytics.eventpayload.customvalues.md index 041969d3..761c4c26 100644 --- a/docs/analytics.eventpayload.customvalues.md +++ b/docs/analytics.eventpayload.customvalues.md @@ -6,7 +6,7 @@ Up to 10 pairs matching custom string keys to number values to associate with the event. Keys are case-insensitive. -Signature: +**Signature:** ```typescript customValues?: Record; diff --git a/docs/analytics.eventpayload.destinationurl.md b/docs/analytics.eventpayload.destinationurl.md index 7003ab3a..acda0052 100644 --- a/docs/analytics.eventpayload.destinationurl.md +++ b/docs/analytics.eventpayload.destinationurl.md @@ -6,7 +6,7 @@ The URL of the page the event is directing the visitor to. -Signature: +**Signature:** ```typescript destinationUrl?: string; diff --git a/docs/analytics.eventpayload.entity.md b/docs/analytics.eventpayload.entity.md index 926a159b..2ee0fd69 100644 --- a/docs/analytics.eventpayload.entity.md +++ b/docs/analytics.eventpayload.entity.md @@ -6,7 +6,7 @@ The Yext entity to which the event corresponds. If passed as a string, the value is the mutable, customer-settable entity ID for the entity associated with the event. If passed as a number, it is the immutable entity ID (UID) set by the system. This is an internal ID. -Signature: +**Signature:** ```typescript entity?: string | number; diff --git a/docs/analytics.eventpayload.internaluser.md b/docs/analytics.eventpayload.internaluser.md index 6d78ef12..ba5d1b05 100644 --- a/docs/analytics.eventpayload.internaluser.md +++ b/docs/analytics.eventpayload.internaluser.md @@ -6,7 +6,7 @@ Indicates whether the event is the result of internal activity. -Signature: +**Signature:** ```typescript internalUser?: boolean; diff --git a/docs/analytics.eventpayload.ip.md b/docs/analytics.eventpayload.ip.md index d92381ab..1b781675 100644 --- a/docs/analytics.eventpayload.ip.md +++ b/docs/analytics.eventpayload.ip.md @@ -6,7 +6,7 @@ The IP address for the event. -Signature: +**Signature:** ```typescript ip?: { diff --git a/docs/analytics.eventpayload.label.md b/docs/analytics.eventpayload.label.md index bc351b89..2020cd94 100644 --- a/docs/analytics.eventpayload.label.md +++ b/docs/analytics.eventpayload.label.md @@ -6,7 +6,7 @@ A label assigned to the event, e.g. a CTA label. -Signature: +**Signature:** ```typescript label?: string; diff --git a/docs/analytics.eventpayload.locale.md b/docs/analytics.eventpayload.locale.md index d5ef716f..b24e2d7b 100644 --- a/docs/analytics.eventpayload.locale.md +++ b/docs/analytics.eventpayload.locale.md @@ -6,7 +6,7 @@ The locale of the user who generated the event. -Signature: +**Signature:** ```typescript locale?: string; diff --git a/docs/analytics.eventpayload.location.md b/docs/analytics.eventpayload.location.md index 751452be..4f4bf032 100644 --- a/docs/analytics.eventpayload.location.md +++ b/docs/analytics.eventpayload.location.md @@ -6,7 +6,7 @@ The location information of the visitor for the event. Either a Coordinates object with both latitude and longitude or a string with the country of the visitor for the event, as a ISO 3166-1 alpha-2 country code. -Signature: +**Signature:** ```typescript location?: Coordinates | string; diff --git a/docs/analytics.eventpayload.md b/docs/analytics.eventpayload.md index 090e446e..25f57eeb 100644 --- a/docs/analytics.eventpayload.md +++ b/docs/analytics.eventpayload.md @@ -6,7 +6,7 @@ The payload accepted by the Analytics Events API. -Signature: +**Signature:** ```typescript export interface EventPayload @@ -14,31 +14,31 @@ export interface EventPayload ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [action](./analytics.eventpayload.action.md) | [Action](./analytics.action.md) | The user action which caused the event, e.g. ADD\_TO\_CART, THUMBS\_UP, C\_CUSTOM\_ACTION | -| [authorization?](./analytics.eventpayload.authorization.md) | string | (Optional) The authorization token for the request. This will be setup from the Key or Bearer in the config. | -| [bot?](./analytics.eventpayload.bot.md) | boolean | (Optional) Whether the event is the result of bot activity. | -| [browserAgent?](./analytics.eventpayload.browseragent.md) | { browser?: string; browserVersion?: string; device?: string; deviceClass?: string; os?: string; osVersion?: string; userAgent?: string; } | (Optional) Information about the visitors device and browser. | -| [chat?](./analytics.eventpayload.chat.md) | { botId: string; conversationId?: string; responseId?: string; } | (Optional) Fields specific to reporting Chat Analytics Events | -| [clientSdk?](./analytics.eventpayload.clientsdk.md) | Record<string, string> | (Optional) For the Yext client SDKs involved in the event, this is an object mapping the names of those SDKs to the version labels of those SDKs. | -| [count?](./analytics.eventpayload.count.md) | number | (Optional) When the record summarizes multiple events, the number of events the record represents. The event is treated as if it is duplicated this many times. | -| [customTags?](./analytics.eventpayload.customtags.md) | Record<string, string> | (Optional) Up to 10 pairs matching custom string keys to string values to associate with the event. Keys are case-insensitive; values are case-sensitive. | -| [customValues?](./analytics.eventpayload.customvalues.md) | Record<string, number> | (Optional) Up to 10 pairs matching custom string keys to number values to associate with the event. Keys are case-insensitive. | -| [destinationUrl?](./analytics.eventpayload.destinationurl.md) | string | (Optional) The URL of the page the event is directing the visitor to. | -| [entity?](./analytics.eventpayload.entity.md) | string \| number | (Optional) The Yext entity to which the event corresponds. If passed as a string, the value is the mutable, customer-settable entity ID for the entity associated with the event. If passed as a number, it is the immutable entity ID (UID) set by the system. This is an internal ID. | -| [internalUser?](./analytics.eventpayload.internaluser.md) | boolean | (Optional) Indicates whether the event is the result of internal activity. | -| [ip?](./analytics.eventpayload.ip.md) | { address: string; algorithm: string; } | (Optional) The IP address for the event. | -| [label?](./analytics.eventpayload.label.md) | string | (Optional) A label assigned to the event, e.g. a CTA label. | -| [locale?](./analytics.eventpayload.locale.md) | string | (Optional) The locale of the user who generated the event. | -| [location?](./analytics.eventpayload.location.md) | Coordinates \| string | (Optional) The location information of the visitor for the event. Either a Coordinates object with both latitude and longitude or a string with the country of the visitor for the event, as a ISO 3166-1 alpha-2 country code. | -| [pageUrl?](./analytics.eventpayload.pageurl.md) | string | (Optional) The URL of the page where the event occurred | -| [referrerUrl?](./analytics.eventpayload.referrerurl.md) | string | (Optional) The URL of the page which the visitor came from prior to the event. | -| [search?](./analytics.eventpayload.search.md) | { searchId?: string; queryId?: string; verticalKey?: string; isDirectAnswer?: boolean; versionLabel?: [VersionLabel](./analytics.versionlabel.md); versionNumber?: number; experienceKey: string; } | (Optional) Fields specific to reporting Yext Search Analytics Events | -| [searchTerm?](./analytics.eventpayload.searchterm.md) | string | (Optional) | -| [sessionId?](./analytics.eventpayload.sessionid.md) | string \| null | (Optional) Unique identifier to tie together events in a single browsing session | -| [sites?](./analytics.eventpayload.sites.md) | { siteUid?: number; template?: string; } | (Optional) Fields specific to reporting Yext Pages Analytics Events | -| [timestamp?](./analytics.eventpayload.timestamp.md) | Date \| string | (Optional) The timestamp at which the event occurred, in ISO format. | -| [value?](./analytics.eventpayload.value.md) | { amount: number; currency: string; } | (Optional) The monetary value of the event. | -| [visitor?](./analytics.eventpayload.visitor.md) | Record<string, string> | (Optional) Information used to associate analytics with a particular user. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [action](./analytics.eventpayload.action.md) | | [Action](./analytics.action.md) | The user action which caused the event, e.g. ADD\_TO\_CART, THUMBS\_UP, C\_CUSTOM\_ACTION | +| [authorization?](./analytics.eventpayload.authorization.md) | | string | _(Optional)_ The authorization token for the request. This will be setup from the Key or Bearer in the config. | +| [bot?](./analytics.eventpayload.bot.md) | | boolean | _(Optional)_ Whether the event is the result of bot activity. | +| [browserAgent?](./analytics.eventpayload.browseragent.md) | | { browser?: string; browserVersion?: string; device?: string; deviceClass?: string; os?: string; osVersion?: string; userAgent?: string; } | _(Optional)_ Information about the visitors device and browser. | +| [chat?](./analytics.eventpayload.chat.md) | | { botId: string; conversationId?: string; responseId?: string; } | _(Optional)_ Fields specific to reporting Chat Analytics Events | +| [clientSdk?](./analytics.eventpayload.clientsdk.md) | | Record<string, string> | _(Optional)_ For the Yext client SDKs involved in the event, this is an object mapping the names of those SDKs to the version labels of those SDKs. | +| [count?](./analytics.eventpayload.count.md) | | number | _(Optional)_ When the record summarizes multiple events, the number of events the record represents. The event is treated as if it is duplicated this many times. | +| [customTags?](./analytics.eventpayload.customtags.md) | | Record<string, string> | _(Optional)_ Up to 10 pairs matching custom string keys to string values to associate with the event. Keys are case-insensitive; values are case-sensitive. | +| [customValues?](./analytics.eventpayload.customvalues.md) | | Record<string, number> | _(Optional)_ Up to 10 pairs matching custom string keys to number values to associate with the event. Keys are case-insensitive. | +| [destinationUrl?](./analytics.eventpayload.destinationurl.md) | | string | _(Optional)_ The URL of the page the event is directing the visitor to. | +| [entity?](./analytics.eventpayload.entity.md) | | string \| number | _(Optional)_ The Yext entity to which the event corresponds. If passed as a string, the value is the mutable, customer-settable entity ID for the entity associated with the event. If passed as a number, it is the immutable entity ID (UID) set by the system. This is an internal ID. | +| [internalUser?](./analytics.eventpayload.internaluser.md) | | boolean | _(Optional)_ Indicates whether the event is the result of internal activity. | +| [ip?](./analytics.eventpayload.ip.md) | | { address: string; algorithm: string; } | _(Optional)_ The IP address for the event. | +| [label?](./analytics.eventpayload.label.md) | | string | _(Optional)_ A label assigned to the event, e.g. a CTA label. | +| [locale?](./analytics.eventpayload.locale.md) | | string | _(Optional)_ The locale of the user who generated the event. | +| [location?](./analytics.eventpayload.location.md) | | Coordinates \| string | _(Optional)_ The location information of the visitor for the event. Either a Coordinates object with both latitude and longitude or a string with the country of the visitor for the event, as a ISO 3166-1 alpha-2 country code. | +| [pageUrl?](./analytics.eventpayload.pageurl.md) | | string | _(Optional)_ The URL of the page where the event occurred | +| [referrerUrl?](./analytics.eventpayload.referrerurl.md) | | string | _(Optional)_ The URL of the page which the visitor came from prior to the event. | +| [search?](./analytics.eventpayload.search.md) | | { searchId?: string; queryId?: string; verticalKey?: string; isDirectAnswer?: boolean; versionLabel?: [VersionLabel](./analytics.versionlabel.md); versionNumber?: number; experienceKey: string; } | _(Optional)_ Fields specific to reporting Yext Search Analytics Events | +| [searchTerm?](./analytics.eventpayload.searchterm.md) | | string | _(Optional)_ | +| [sessionId?](./analytics.eventpayload.sessionid.md) | | string \| null | _(Optional)_ Unique identifier to tie together events in a single browsing session | +| [sites?](./analytics.eventpayload.sites.md) | | { siteUid?: number; template?: string; } | _(Optional)_ Fields specific to reporting Yext Pages Analytics Events | +| [timestamp?](./analytics.eventpayload.timestamp.md) | | Date \| string | _(Optional)_ The timestamp at which the event occurred, in ISO format. | +| [value?](./analytics.eventpayload.value.md) | | { amount: number; currency: string; } | _(Optional)_ The monetary value of the event. | +| [visitor?](./analytics.eventpayload.visitor.md) | | Record<string, string> | _(Optional)_ Information used to associate analytics with a particular user. | diff --git a/docs/analytics.eventpayload.pageurl.md b/docs/analytics.eventpayload.pageurl.md index 6e1b739c..9ace1643 100644 --- a/docs/analytics.eventpayload.pageurl.md +++ b/docs/analytics.eventpayload.pageurl.md @@ -6,7 +6,7 @@ The URL of the page where the event occurred -Signature: +**Signature:** ```typescript pageUrl?: string; diff --git a/docs/analytics.eventpayload.referrerurl.md b/docs/analytics.eventpayload.referrerurl.md index 39d02695..67ed2680 100644 --- a/docs/analytics.eventpayload.referrerurl.md +++ b/docs/analytics.eventpayload.referrerurl.md @@ -6,7 +6,7 @@ The URL of the page which the visitor came from prior to the event. -Signature: +**Signature:** ```typescript referrerUrl?: string; diff --git a/docs/analytics.eventpayload.search.md b/docs/analytics.eventpayload.search.md index 794abaf3..c2684a38 100644 --- a/docs/analytics.eventpayload.search.md +++ b/docs/analytics.eventpayload.search.md @@ -6,7 +6,7 @@ Fields specific to reporting Yext Search Analytics Events -Signature: +**Signature:** ```typescript search?: { diff --git a/docs/analytics.eventpayload.searchterm.md b/docs/analytics.eventpayload.searchterm.md index f1d7e494..ca6a7444 100644 --- a/docs/analytics.eventpayload.searchterm.md +++ b/docs/analytics.eventpayload.searchterm.md @@ -4,7 +4,7 @@ ## EventPayload.searchTerm property -Signature: +**Signature:** ```typescript searchTerm?: string; diff --git a/docs/analytics.eventpayload.sessionid.md b/docs/analytics.eventpayload.sessionid.md index 2d0bafe1..fd352b4a 100644 --- a/docs/analytics.eventpayload.sessionid.md +++ b/docs/analytics.eventpayload.sessionid.md @@ -6,7 +6,7 @@ Unique identifier to tie together events in a single browsing session -Signature: +**Signature:** ```typescript sessionId?: string | null; diff --git a/docs/analytics.eventpayload.sites.md b/docs/analytics.eventpayload.sites.md index dca4a0e4..6dec1af3 100644 --- a/docs/analytics.eventpayload.sites.md +++ b/docs/analytics.eventpayload.sites.md @@ -6,7 +6,7 @@ Fields specific to reporting Yext Pages Analytics Events -Signature: +**Signature:** ```typescript sites?: { diff --git a/docs/analytics.eventpayload.timestamp.md b/docs/analytics.eventpayload.timestamp.md index 2ebbd142..fee6e995 100644 --- a/docs/analytics.eventpayload.timestamp.md +++ b/docs/analytics.eventpayload.timestamp.md @@ -6,7 +6,7 @@ The timestamp at which the event occurred, in ISO format. -Signature: +**Signature:** ```typescript timestamp?: Date | string; diff --git a/docs/analytics.eventpayload.value.md b/docs/analytics.eventpayload.value.md index 4cce50bf..6882f57c 100644 --- a/docs/analytics.eventpayload.value.md +++ b/docs/analytics.eventpayload.value.md @@ -6,7 +6,7 @@ The monetary value of the event. -Signature: +**Signature:** ```typescript value?: { diff --git a/docs/analytics.eventpayload.visitor.md b/docs/analytics.eventpayload.visitor.md index 999461f8..dc86035d 100644 --- a/docs/analytics.eventpayload.visitor.md +++ b/docs/analytics.eventpayload.visitor.md @@ -6,7 +6,7 @@ Information used to associate analytics with a particular user. -Signature: +**Signature:** ```typescript visitor?: Record; diff --git a/docs/analytics.partialpayload.md b/docs/analytics.partialpayload.md index fd540538..9e9b60ba 100644 --- a/docs/analytics.partialpayload.md +++ b/docs/analytics.partialpayload.md @@ -6,10 +6,10 @@ A Payload that is a subset of the EventPayload -Signature: +**Signature:** ```typescript export declare type PartialPayload = Partial>; ``` -References: [EventPayload](./analytics.eventpayload.md) +**References:** [EventPayload](./analytics.eventpayload.md) diff --git a/docs/analytics.region.md b/docs/analytics.region.md index e7d8a04e..f1eea7da 100644 --- a/docs/analytics.region.md +++ b/docs/analytics.region.md @@ -6,12 +6,12 @@ The physical region of the Yext account -Signature: +**Signature:** ```typescript export declare type Region = EnumOrString; ``` -References: [EnumOrString](./analytics.enumorstring.md), [RegionEnum](./analytics.regionenum.md) +**References:** [EnumOrString](./analytics.enumorstring.md), [RegionEnum](./analytics.regionenum.md) ## Remarks diff --git a/docs/analytics.regionenum.md b/docs/analytics.regionenum.md index aad788c6..2476066b 100644 --- a/docs/analytics.regionenum.md +++ b/docs/analytics.regionenum.md @@ -6,7 +6,7 @@ An enum of the physical region the Yext account -Signature: +**Signature:** ```typescript export declare enum RegionEnum diff --git a/docs/analytics.versionlabel.md b/docs/analytics.versionlabel.md index abaf18ad..cc3562a0 100644 --- a/docs/analytics.versionlabel.md +++ b/docs/analytics.versionlabel.md @@ -6,12 +6,12 @@ The Search Version Label -Signature: +**Signature:** ```typescript export declare type VersionLabel = EnumOrString; ``` -References: [EnumOrString](./analytics.enumorstring.md), [VersionLabelEnum](./analytics.versionlabelenum.md) +**References:** [EnumOrString](./analytics.enumorstring.md), [VersionLabelEnum](./analytics.versionlabelenum.md) ## Remarks diff --git a/docs/analytics.versionlabelenum.md b/docs/analytics.versionlabelenum.md index 2d742247..0b4a3911 100644 --- a/docs/analytics.versionlabelenum.md +++ b/docs/analytics.versionlabelenum.md @@ -6,7 +6,7 @@ An enum for the Search Version Labels -Signature: +**Signature:** ```typescript export declare enum VersionLabelEnum