EventsSDK: add generativeDirectAnswer and CITATION_CLICK event for se…

…arch This PR adds generativeDirectAnswer field to CtaEvent and defines CITATION_CLICK as a SearchAnalyticsEventType
yext · Feb 7, 2025 · d4d45ab · d4d45ab
1 parent 5146280
commit d4d45ab
Show file tree

Hide file tree

Showing 9 changed files with 30 additions and 7 deletions.
diff --git a/docs/analytics.ctaevent.generativedirectanswer.md b/docs/analytics.ctaevent.generativedirectanswer.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/analytics](./analytics.md) &gt; [CtaEvent](./analytics.ctaevent.md) &gt; [generativeDirectAnswer](./analytics.ctaevent.generativedirectanswer.md)
+
+## CtaEvent.generativeDirectAnswer property
+
+Whether or not the event was fired on a generative direct answer card.
+
+<b>Signature:</b>
+
+```typescript
+generativeDirectAnswer?: boolean;
+```
diff --git a/docs/analytics.ctaevent.md b/docs/analytics.ctaevent.md
@@ -20,9 +20,10 @@ export interface CtaEvent
 |  [directAnswer?](./analytics.ctaevent.directanswer.md) | boolean | <i>(Optional)</i> Whether or not the event was fired on a direct answer card. |
 |  [entityId](./analytics.ctaevent.entityid.md) | string | The entity ID for the entity. |
 |  [fieldName?](./analytics.ctaevent.fieldname.md) | string | <i>(Optional)</i> The name of the Rich Text field used. |
+|  [generativeDirectAnswer?](./analytics.ctaevent.generativedirectanswer.md) | boolean | <i>(Optional)</i> Whether or not the event was fired on a generative direct answer card. |
 |  [queryId](./analytics.ctaevent.queryid.md) | string | The ID of the most recent query. |
 |  [searcher](./analytics.ctaevent.searcher.md) | [Searcher](./analytics.searcher.md) | Whether it was on universal or vertical search. |
-|  [type](./analytics.ctaevent.type.md) | [EnumOrString](./analytics.enumorstring.md)<!-- -->&lt;[SearchAnalyticsEventType.CtaClick](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.TitleClick](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.TapToCall](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.OrderNow](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.AddToCart](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.ApplyNow](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.DrivingDirections](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.ViewWebsite](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.Email](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.BookAppointment](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.Rsvp](./analytics.searchanalyticseventtype.md)<!-- -->&gt; | An enum member or its string value which denotes the event type. |
+|  [type](./analytics.ctaevent.type.md) | [EnumOrString](./analytics.enumorstring.md)<!-- -->&lt;[SearchAnalyticsEventType.CtaClick](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.TitleClick](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.TapToCall](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.OrderNow](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.AddToCart](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.ApplyNow](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.DrivingDirections](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.ViewWebsite](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.Email](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.BookAppointment](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.Rsvp](./analytics.searchanalyticseventtype.md) \| [SearchAnalyticsEventType.CitationClick](./analytics.searchanalyticseventtype.md)<!-- -->&gt; | An enum member or its string value which denotes the event type. |
 |  [url?](./analytics.ctaevent.url.md) | string | <i>(Optional)</i> The url of the event target. |
 |  [verticalKey](./analytics.ctaevent.verticalkey.md) | string | The vertical key for the vertical on which the event was fired. Or, if it is a universal search, the vertical key for the section in the universal results. |
 
diff --git a/docs/analytics.ctaevent.type.md b/docs/analytics.ctaevent.type.md
@@ -9,5 +9,5 @@ An enum member or its string value which denotes the event type.
 <b>Signature:</b>
 
 ```typescript
-type: EnumOrString<SearchAnalyticsEventType.CtaClick | SearchAnalyticsEventType.TitleClick | SearchAnalyticsEventType.TapToCall | SearchAnalyticsEventType.OrderNow | SearchAnalyticsEventType.AddToCart | SearchAnalyticsEventType.ApplyNow | SearchAnalyticsEventType.DrivingDirections | SearchAnalyticsEventType.ViewWebsite | SearchAnalyticsEventType.Email | SearchAnalyticsEventType.BookAppointment | SearchAnalyticsEventType.Rsvp>;
+type: EnumOrString<SearchAnalyticsEventType.CtaClick | SearchAnalyticsEventType.TitleClick | SearchAnalyticsEventType.TapToCall | SearchAnalyticsEventType.OrderNow | SearchAnalyticsEventType.AddToCart | SearchAnalyticsEventType.ApplyNow | SearchAnalyticsEventType.DrivingDirections | SearchAnalyticsEventType.ViewWebsite | SearchAnalyticsEventType.Email | SearchAnalyticsEventType.BookAppointment | SearchAnalyticsEventType.Rsvp | SearchAnalyticsEventType.CitationClick>;
 ```
diff --git a/docs/analytics.searchanalyticseventtype.md b/docs/analytics.searchanalyticseventtype.md
@@ -21,6 +21,7 @@ export declare enum SearchAnalyticsEventType
 |  ApplyNow | <code>&quot;APPLY_NOW&quot;</code> | [CtaEvent](./analytics.ctaevent.md) |
 |  AutocompleteSelection | <code>&quot;AUTO_COMPLETE_SELECTION&quot;</code> | [AutocompleteEvent](./analytics.autocompleteevent.md) |
 |  BookAppointment | <code>&quot;BOOK_APPOINTMENT&quot;</code> | [CtaEvent](./analytics.ctaevent.md) |
+|  CitationClick | <code>&quot;CITATION_CLICK&quot;</code> | [CtaEvent](./analytics.ctaevent.md) |
 |  CtaClick | <code>&quot;CTA_CLICK&quot;</code> | [CtaEvent](./analytics.ctaevent.md) |
 |  DrivingDirections | <code>&quot;DRIVING_DIRECTIONS&quot;</code> | [CtaEvent](./analytics.ctaevent.md) |
 |  Email | <code>&quot;EMAIL&quot;</code> | [CtaEvent](./analytics.ctaevent.md) |

diff --git a/etc/analytics.api.md b/etc/analytics.api.md
@@ -109,9 +109,10 @@ export interface CtaEvent {
     directAnswer?: boolean;
     entityId: string;
     fieldName?: string;
+    generativeDirectAnswer?: boolean;
     queryId: string;
     searcher: Searcher;
-    type: EnumOrString<SearchAnalyticsEventType.CtaClick | SearchAnalyticsEventType.TitleClick | SearchAnalyticsEventType.TapToCall | SearchAnalyticsEventType.OrderNow | SearchAnalyticsEventType.AddToCart | SearchAnalyticsEventType.ApplyNow | SearchAnalyticsEventType.DrivingDirections | SearchAnalyticsEventType.ViewWebsite | SearchAnalyticsEventType.Email | SearchAnalyticsEventType.BookAppointment | SearchAnalyticsEventType.Rsvp>;
+    type: EnumOrString<SearchAnalyticsEventType.CtaClick | SearchAnalyticsEventType.TitleClick | SearchAnalyticsEventType.TapToCall | SearchAnalyticsEventType.OrderNow | SearchAnalyticsEventType.AddToCart | SearchAnalyticsEventType.ApplyNow | SearchAnalyticsEventType.DrivingDirections | SearchAnalyticsEventType.ViewWebsite | SearchAnalyticsEventType.Email | SearchAnalyticsEventType.BookAppointment | SearchAnalyticsEventType.Rsvp | SearchAnalyticsEventType.CitationClick>;
     url?: string;
     verticalKey: string;
 }
@@ -329,6 +330,8 @@ enum SearchAnalyticsEventType {
     // (undocumented)
     BookAppointment = "BOOK_APPOINTMENT",
     // (undocumented)
+    CitationClick = "CITATION_CLICK",
+    // (undocumented)
     CtaClick = "CTA_CLICK",
     // (undocumented)
     DrivingDirections = "DRIVING_DIRECTIONS",

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@yext/analytics",
-  "version": "0.6.6",
+  "version": "0.6.7",
   "description": "An analytics library for Yext",
   "author": "[email protected]",
   "license": "BSD-3-Clause",

diff --git a/src/models/search/SearchAnalyticsEventType.ts b/src/models/search/SearchAnalyticsEventType.ts
@@ -60,6 +60,8 @@ export enum SearchAnalyticsEventType {
   BookAppointment = 'BOOK_APPOINTMENT',
   /** {@link CtaEvent} */
   Rsvp = 'RSVP',
+  /** {@link CtaEvent} */
+  CitationClick = 'CITATION_CLICK',
 
   // Search duration event types
   /** {@link SearchDurationEvent} */

diff --git a/src/models/search/events/CtaEvent.ts b/src/models/search/events/CtaEvent.ts
@@ -21,7 +21,8 @@ export interface CtaEvent {
     SearchAnalyticsEventType.ViewWebsite |
     SearchAnalyticsEventType.Email |
     SearchAnalyticsEventType.BookAppointment |
-    SearchAnalyticsEventType.Rsvp
+    SearchAnalyticsEventType.Rsvp |
+    SearchAnalyticsEventType.CitationClick
   >,
   /**
    * The vertical key for the vertical on which the event was fired. Or, if
@@ -37,6 +38,8 @@ export interface CtaEvent {
   queryId: string,
   /** Whether or not the event was fired on a direct answer card. */
   directAnswer?: boolean,
+  /** Whether or not the event was fired on a generative direct answer card. */
+  generativeDirectAnswer?: boolean,
   /** The url of the event target. */
   url?: string,
   /** The name of the Rich Text field used. */