From ba8fe58d7866d81da87e4b2f0d22e44aad31d6cc Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 20 Feb 2024 22:16:01 +0000 Subject: [PATCH] Automated update to repo's documentation from github action --- docs/analytics.eventpayload.md | 2 +- docs/analytics.eventpayload.pages.md | 1 + etc/analytics.api.md | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/analytics.eventpayload.md b/docs/analytics.eventpayload.md index abee73c3..195de78e 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. | | [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. | -| [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 | | [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 | diff --git a/docs/analytics.eventpayload.pages.md b/docs/analytics.eventpayload.pages.md index 9dc63541..2fd00546 100644 --- a/docs/analytics.eventpayload.pages.md +++ b/docs/analytics.eventpayload.pages.md @@ -10,6 +10,7 @@ Fields specific to reporting Yext Pages Analytics Events ```typescript pages?: { + scope?: string; siteUid?: number; template?: string; }; diff --git a/etc/analytics.api.md b/etc/analytics.api.md index 2598571b..5ba5f4ab 100644 --- a/etc/analytics.api.md +++ b/etc/analytics.api.md @@ -65,6 +65,7 @@ export interface EventPayload { // Warning: (ae-forgotten-export) The symbol "Coordinates" needs to be exported by the entry point index.d.ts location?: Coordinates | string; pages?: { + scope?: string; siteUid?: number; template?: string; };