From e9481352d4e66d8bfea0a9f4347765cf2ff90b50 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 22 Feb 2024 00:04:55 +0000 Subject: [PATCH] Automated update to repo's documentation from github action --- docs/analytics.eventpayload.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/analytics.eventpayload.md b/docs/analytics.eventpayload.md index 185f2a9..c6a983f 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 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.

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) | | { siteUid?: number; template?: string; } | _(Optional)_ Fields specific to reporting Yext Pages Analytics Events | +| [pages?](./analytics.eventpayload.pages.md) | | { scope?: 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 Referer header of the request.

| | [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 Referer header of the request.

| | [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 |