From e19f1efe2311af2f6116b29bb25d8d8200849969 Mon Sep 17 00:00:00 2001
From: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Date: Thu, 29 Feb 2024 16:18:10 +0000
Subject: [PATCH] Automated update to repo's documentation from github action
---
docs/analytics.eventpayload.md | 2 +-
docs/analytics.eventpayload.searchterm.md | 2 ++
etc/analytics.api.md | 1 -
3 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/docs/analytics.eventpayload.md b/docs/analytics.eventpayload.md
index 525bcba..f4ed943 100644
--- a/docs/analytics.eventpayload.md
+++ b/docs/analytics.eventpayload.md
@@ -36,7 +36,7 @@ export interface EventPayload
| [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)_ |
+| [searchTerm?](./analytics.eventpayload.searchterm.md) | | string | _(Optional)_ The query entered by the user. |
| [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. 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. |
diff --git a/docs/analytics.eventpayload.searchterm.md b/docs/analytics.eventpayload.searchterm.md
index ca6a744..ef1c37c 100644
--- a/docs/analytics.eventpayload.searchterm.md
+++ b/docs/analytics.eventpayload.searchterm.md
@@ -4,6 +4,8 @@
## EventPayload.searchTerm property
+The query entered by the user.
+
**Signature:**
```typescript
diff --git a/etc/analytics.api.md b/etc/analytics.api.md
index 616419f..ea4aa75 100644
--- a/etc/analytics.api.md
+++ b/etc/analytics.api.md
@@ -81,7 +81,6 @@ export interface EventPayload {
versionNumber?: number;
experienceKey: string;
};
- // (undocumented)
searchTerm?: string;
sessionId?: string | null;
timestamp?: Date | string;