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 27, 2024
1 parent 0f89992 commit 95dec97
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 15 deletions.
16 changes: 4 additions & 12 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. |
| [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)
| [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 | <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 auto-generated 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 auto-generated 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.</p><p>If not specified the system will automatically use the time when the request was received 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 auto-generated 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 auto-generated request headers.

**Signature:**

Expand Down
2 changes: 1 addition & 1 deletion docs/analytics.eventpayload.timestamp.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## 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.

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

Expand Down

0 comments on commit 95dec97

Please sign in to comment.