diff --git a/docs/analytics.eventpayload.md b/docs/analytics.eventpayload.md index 543f445..525bcba 100644 --- a/docs/analytics.eventpayload.md +++ b/docs/analytics.eventpayload.md @@ -32,7 +32,7 @@ export interface EventPayload | [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.

If not specified the system will automatically determine the locale from the autogenerated Accept-Language header.

| | [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. For more information see https://www.iso.org/iso-3166-country-codes.html.

If not specified the system will automatically determine all location information from the request's IP address, or the value of the ip property if specified.

| -| [pages?](./analytics.eventpayload.pages.md) | | { scope?: string; siteUid?: number; template?: string; } | _(Optional)_ Fields specific to reporting Yext Pages Analytics Events | +| [pages?](./analytics.eventpayload.pages.md) | | { scope?: string; originalEventName?: string; siteUid?: number; template?: string; } | _(Optional)_ Fields specific to reporting Yext Pages Analytics Events | | [pageUrl?](./analytics.eventpayload.pageurl.md) | | string |

_(Optional)_ The URL of the page where the event occurred.

If not specified the system will automatically use the Referrer header from the autogenerated request headers.

| | [referrerUrl?](./analytics.eventpayload.referrerurl.md) | | string |

_(Optional)_ The URL of the page which the visitor came from prior to the event.

If not specified the system will automatically use the Referrer header from the autogenerated request headers.

| | [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 | diff --git a/docs/analytics.eventpayload.pages.md b/docs/analytics.eventpayload.pages.md index 2fd0054..1b74f2f 100644 --- a/docs/analytics.eventpayload.pages.md +++ b/docs/analytics.eventpayload.pages.md @@ -11,6 +11,7 @@ Fields specific to reporting Yext Pages Analytics Events ```typescript pages?: { scope?: string; + originalEventName?: string; siteUid?: number; template?: string; }; diff --git a/etc/analytics.api.md b/etc/analytics.api.md index 59d5f93..616419f 100644 --- a/etc/analytics.api.md +++ b/etc/analytics.api.md @@ -66,6 +66,7 @@ export interface EventPayload { location?: Coordinates | string; pages?: { scope?: string; + originalEventName?: string; siteUid?: number; template?: string; }; diff --git a/src/EventPayload.ts b/src/EventPayload.ts index 8e098b2..849b0bc 100644 --- a/src/EventPayload.ts +++ b/src/EventPayload.ts @@ -110,6 +110,8 @@ export interface EventPayload { pages?: { /** The scope of an action. Applies to Pages events. */ scope?: string; + /** The Event name as it was used in previous analytics implementations. */ + originalEventName?: string; /* The UID of the site an event was tied to. */ siteUid?: number; /* The ID of the template from which a site was generated. */