From 6bdb0a5c066617cd8c3fe4416aa99af34f9f0b2c Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 28 Feb 2024 18:24:22 +0000 Subject: [PATCH] Automated update to repo's documentation from github action --- docs/analytics.eventpayload.locale.md | 2 +- docs/analytics.eventpayload.location.md | 2 +- docs/analytics.eventpayload.md | 18 +++++------------- docs/analytics.eventpayload.pageurl.md | 2 +- docs/analytics.eventpayload.referrerurl.md | 2 +- docs/analytics.eventpayload.timestamp.md | 4 ++-- 6 files changed, 11 insertions(+), 19 deletions(-) diff --git a/docs/analytics.eventpayload.locale.md b/docs/analytics.eventpayload.locale.md index 4f1d1c3..cca3f00 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. -If not specified the system will automatically determine the locale from the Accept-Language header. +If not specified the system will automatically determine the locale from the autogenerated Accept-Language header. **Signature:** diff --git a/docs/analytics.eventpayload.location.md b/docs/analytics.eventpayload.location.md index 4792303..fea9828 100644 --- a/docs/analytics.eventpayload.location.md +++ b/docs/analytics.eventpayload.location.md @@ -4,7 +4,7 @@ ## EventPayload.location property -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. +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. diff --git a/docs/analytics.eventpayload.md b/docs/analytics.eventpayload.md index 47db9af..543f445 100644 --- a/docs/analytics.eventpayload.md +++ b/docs/analytics.eventpayload.md @@ -30,23 +30,15 @@ export interface EventPayload | [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. | -<<<<<<< HEAD -| [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. | +| [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 | -| [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. | -======= -| [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 | -| [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.

| ->>>>>>> 13bbe96 (Automated update to repo's documentation from github action) +| [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 | | [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 | -| [timestamp?](./analytics.eventpayload.timestamp.md) | | Date \| string |

_(Optional)_ The timestamp at which the event occurred, in ISO format.

If not specified the system will automatically use the time when the request was received as the event timestamp.

| +| [timestamp?](./analytics.eventpayload.timestamp.md) | | Date \| string |

_(Optional)_ The timestamp at which the event occurred, in ISO format. For example, September 27, 2022 at 6 p.m. is represented as 2022-09-27 18:00:00.000. For more information, see https://www.iso.org/iso-8601-date-and-time-format.html.

If not specified the system will automatically use the time when the request was received in UTC as the event timestamp.

| | [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 7e8a7a5..0b0535f 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. -If not specified the system will automatically use the `Referer` header of the request. +If not specified the system will automatically use the `Referrer` header from the autogenerated request headers. **Signature:** diff --git a/docs/analytics.eventpayload.referrerurl.md b/docs/analytics.eventpayload.referrerurl.md index 3355d65..904a99e 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. -If not specified the system will automatically use the `Referer` header of the request. +If not specified the system will automatically use the `Referrer` header from the autogenerated request headers. **Signature:** diff --git a/docs/analytics.eventpayload.timestamp.md b/docs/analytics.eventpayload.timestamp.md index 15890cd..0e66466 100644 --- a/docs/analytics.eventpayload.timestamp.md +++ b/docs/analytics.eventpayload.timestamp.md @@ -4,9 +4,9 @@ ## EventPayload.timestamp property -The timestamp at which the event occurred, in ISO format. +The timestamp at which the event occurred, in ISO format. For example, September 27, 2022 at 6 p.m. is represented as 2022-09-27 18:00:00.000. For more information, see https://www.iso.org/iso-8601-date-and-time-format.html. -If not specified the system will automatically use the time when the request was received as the event timestamp. +If not specified the system will automatically use the time when the request was received in UTC as the event timestamp. **Signature:**