Skip to content

Commit

Permalink
Automated update to repo's documentation from github action
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Feb 28, 2024
1 parent 1734029 commit 6bdb0a5
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 19 deletions.
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.locale.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand Down
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.location.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
18 changes: 5 additions & 13 deletions docs/analytics.eventpayload.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 | <p>_(Optional)_ The locale of the user who generated the event.</p><p>If not specified the system will automatically determine the locale from the autogenerated Accept-Language header.</p> |
| [location?](./analytics.eventpayload.location.md) | | Coordinates \| string | <p>_(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.</p><p>If not specified the system will automatically determine all location information from the request's IP address, or the value of the <code>ip</code> property if specified.</p> |
| [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 | <p>_(Optional)_ The locale of the user who generated the event.</p><p>If not specified the system will automatically determine the locale from the Accept-Language header.</p> |
| [location?](./analytics.eventpayload.location.md) | | Coordinates \| string | <p>_(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.</p><p>If not specified the system will automatically determine all location information from the request's IP address, or the value of the <code>ip</code> property if specified.</p> |
| [pages?](./analytics.eventpayload.pages.md) | | { siteUid?: number; template?: string; } | _(Optional)_ Fields specific to reporting Yext Pages Analytics Events |
| [pageUrl?](./analytics.eventpayload.pageurl.md) | | string | <p>_(Optional)_ The URL of the page where the event occurred.</p><p>If not specified the system will automatically use the <code>Referer</code> header of the request.</p> |
| [referrerUrl?](./analytics.eventpayload.referrerurl.md) | | string | <p>_(Optional)_ The URL of the page which the visitor came from prior to the event.</p><p>If not specified the system will automatically use the <code>Referer</code> header of the request.</p> |
>>>>>>> 13bbe96 (Automated update to repo's documentation from github action)
| [pageUrl?](./analytics.eventpayload.pageurl.md) | | string | <p>_(Optional)_ The URL of the page where the event occurred.</p><p>If not specified the system will automatically use the <code>Referrer</code> header from the autogenerated request headers.</p> |
| [referrerUrl?](./analytics.eventpayload.referrerurl.md) | | string | <p>_(Optional)_ The URL of the page which the visitor came from prior to the event.</p><p>If not specified the system will automatically use the <code>Referrer</code> header from the autogenerated request headers.</p> |
| [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 | <p>_(Optional)_ The timestamp at which the event occurred, in ISO format.</p><p>If not specified the system will automatically use the time when the request was received as the event timestamp.</p> |
| [timestamp?](./analytics.eventpayload.timestamp.md) | | Date \| string | <p>_(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.</p><p>If not specified the system will automatically use the time when the request was received in UTC as the event timestamp.</p> |
| [value?](./analytics.eventpayload.value.md) | | { amount: number; currency: string; } | _(Optional)_ The monetary value of the event. |
| [visitor?](./analytics.eventpayload.visitor.md) | | Record&lt;string, string&gt; | _(Optional)_ Information used to associate analytics with a particular user. |

2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.pageurl.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand Down
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.referrerurl.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand Down
4 changes: 2 additions & 2 deletions docs/analytics.eventpayload.timestamp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand Down

0 comments on commit 6bdb0a5

Please sign in to comment.