coveo.analytics 2.28.21 → 2.28.22

package/dist/definitions/insight/insightClient.d.ts

@@ -1,7 +1,7 @@
 import { AnalyticsClient, ClientOptions } from '../client/analytics';
 import { SearchEventRequest } from '../events';
 import { DocumentIdentifier, FacetStateMetadata, GeneratedAnswerBaseMeta, GeneratedAnswerCitationMeta, GeneratedAnswerFeedbackMeta, GeneratedAnswerRephraseMeta, GeneratedAnswerSourceHoverMeta, GeneratedAnswerStreamEndMeta, PartialDocumentInformation, SearchPageEvents, SmartSnippetDocumentIdentifier, SmartSnippetFeedbackReason, SmartSnippetLinkMeta, SmartSnippetSuggestionMeta } from '../searchPage/searchPageEvents';
-import { ExpandToFullUIMetadata, InsightEvents, InsightFacetMetadata, InsightInterfaceChangeMetadata, InsightStaticFilterToggleValueMetadata, InsightFacetRangeMetadata, InsightCategoryFacetMetadata, CaseMetadata, InsightFacetSortMeta, InsightFacetBaseMeta, InsightQueryErrorMeta, InsightPagerMetadata, InsightResultsSortMetadata, UserActionsDocumentMetadata, UserActionsPageViewMetadata } from './insightEvents';
+import { ExpandToFullUIMetadata, InsightEvents, InsightFacetMetadata, InsightInterfaceChangeMetadata, InsightStaticFilterToggleValueMetadata, InsightFacetRangeMetadata, InsightCategoryFacetMetadata, CaseMetadata, InsightFacetSortMeta, InsightFacetBaseMeta, InsightQueryErrorMeta, InsightPagerMetadata, InsightResultsSortMetadata, UserActionsDocumentMetadata, UserActionsPageViewMetadata, CreateArticleMetadata } from './insightEvents';
 export interface InsightClientProvider {
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
     getSearchUID: () => string;
@@ -54,6 +54,7 @@ export declare class CoveoInsightClient {
     logShowFollowingSessions(metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     logViewedDocumentClick(document: UserActionsDocumentMetadata, metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     logPageViewClick(pageView: UserActionsPageViewMetadata, metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logCreateArticle(createArticleMetadata: CreateArticleMetadata, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
     logCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
     logCaseSendEmail(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;

package/dist/definitions/insight/insightEvents.d.ts

@@ -6,7 +6,8 @@ export declare enum InsightEvents {
     showPrecedingSessions = "showPrecedingSessions",
     showFollowingSessions = "showFollowingSessions",
     clickViewedDocument = "clickViewedDocument",
-    clickPageView = "clickPageView"
+    clickPageView = "clickPageView",
+    createArticle = "createArticle"
 }
 export interface CaseMetadata {
     caseId?: string;
@@ -28,6 +29,10 @@ export interface UserActionsPageViewMetadata {
     contentIdKey: string;
     contentIdValue: string;
 }
+export interface CreateArticleMetadata {
+    articleType: string;
+    triggeredBy: string;
+}
 export interface InsightInterfaceChangeMetadata extends InterfaceChangeMetadata, CaseMetadata {
 }
 export interface InsightFacetMetadata extends FacetMetadata, CaseMetadata {

package/dist/definitions/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.28.21";
+export declare const libVersion = "2.28.22";

package/dist/library.cjs

@@ -731,7 +731,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.28.21" ;
+var libVersion = "2.28.22" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84203,6 +84203,7 @@ exports.InsightEvents = void 0;
     InsightEvents["showFollowingSessions"] = "showFollowingSessions";
     InsightEvents["clickViewedDocument"] = "clickViewedDocument";
     InsightEvents["clickPageView"] = "clickPageView";
+    InsightEvents["createArticle"] = "createArticle";
 })(exports.InsightEvents || (exports.InsightEvents = {}));
 
 var _a;
@@ -84325,12 +84326,6 @@ var CustomEventsTypes = (_a = {},
     _a[exports.SearchPageEvents.recentResultClick] = 'recentlyClickedDocuments',
     _a[exports.SearchPageEvents.clearRecentResults] = 'recentlyClickedDocuments',
     _a[exports.SearchPageEvents.showLessFoldedResults] = 'folding',
-    _a[exports.InsightEvents.expandToFullUI] = 'interface',
-    _a[exports.InsightEvents.openUserActions] = 'User Actions',
-    _a[exports.InsightEvents.showPrecedingSessions] = 'User Actions',
-    _a[exports.InsightEvents.showFollowingSessions] = 'User Actions',
-    _a[exports.InsightEvents.clickViewedDocument] = 'User Actions',
-    _a[exports.InsightEvents.clickPageView] = 'User Actions',
     _a[exports.SearchPageEvents.caseDetach] = 'case',
     _a[exports.SearchPageEvents.likeGeneratedAnswer] = 'generatedAnswer',
     _a[exports.SearchPageEvents.dislikeGeneratedAnswer] = 'generatedAnswer',
@@ -84341,6 +84336,13 @@ var CustomEventsTypes = (_a = {},
     _a[exports.SearchPageEvents.generatedAnswerHideAnswers] = 'generatedAnswer',
     _a[exports.SearchPageEvents.generatedAnswerShowAnswers] = 'generatedAnswer',
     _a[exports.SearchPageEvents.generatedAnswerFeedbackSubmit] = 'generatedAnswer',
+    _a[exports.InsightEvents.expandToFullUI] = 'interface',
+    _a[exports.InsightEvents.openUserActions] = 'User Actions',
+    _a[exports.InsightEvents.showPrecedingSessions] = 'User Actions',
+    _a[exports.InsightEvents.showFollowingSessions] = 'User Actions',
+    _a[exports.InsightEvents.clickViewedDocument] = 'User Actions',
+    _a[exports.InsightEvents.clickPageView] = 'User Actions',
+    _a[exports.InsightEvents.createArticle] = 'createArticle',
     _a);
 
 var NoopAnalytics = (function () {
@@ -86062,6 +86064,9 @@ var CoveoInsightClient = (function () {
     CoveoInsightClient.prototype.logPageViewClick = function (pageView, metadata) {
         return this.logCustomEvent(exports.InsightEvents.clickPageView, __assign(__assign({}, generateMetadataToSend(metadata, false)), { pageView: pageView }));
     };
+    CoveoInsightClient.prototype.logCreateArticle = function (createArticleMetadata, metadata) {
+        return this.logCustomEvent(exports.InsightEvents.createArticle, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), createArticleMetadata) : createArticleMetadata);
+    };
     CoveoInsightClient.prototype.logDocumentOpen = function (info, identifier, metadata) {
         return this.logClickEvent(exports.SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
     };

package/dist/library.es.js

@@ -596,7 +596,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-const libVersion = "2.28.21" ;
+const libVersion = "2.28.22" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1689,6 +1689,7 @@ var InsightEvents;
     InsightEvents["showFollowingSessions"] = "showFollowingSessions";
     InsightEvents["clickViewedDocument"] = "clickViewedDocument";
     InsightEvents["clickPageView"] = "clickPageView";
+    InsightEvents["createArticle"] = "createArticle";
 })(InsightEvents || (InsightEvents = {}));
 
 var SearchPageEvents;
@@ -1810,12 +1811,6 @@ const CustomEventsTypes = {
     [SearchPageEvents.recentResultClick]: 'recentlyClickedDocuments',
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
     [SearchPageEvents.showLessFoldedResults]: 'folding',
-    [InsightEvents.expandToFullUI]: 'interface',
-    [InsightEvents.openUserActions]: 'User Actions',
-    [InsightEvents.showPrecedingSessions]: 'User Actions',
-    [InsightEvents.showFollowingSessions]: 'User Actions',
-    [InsightEvents.clickViewedDocument]: 'User Actions',
-    [InsightEvents.clickPageView]: 'User Actions',
     [SearchPageEvents.caseDetach]: 'case',
     [SearchPageEvents.likeGeneratedAnswer]: 'generatedAnswer',
     [SearchPageEvents.dislikeGeneratedAnswer]: 'generatedAnswer',
@@ -1826,6 +1821,13 @@ const CustomEventsTypes = {
     [SearchPageEvents.generatedAnswerHideAnswers]: 'generatedAnswer',
     [SearchPageEvents.generatedAnswerShowAnswers]: 'generatedAnswer',
     [SearchPageEvents.generatedAnswerFeedbackSubmit]: 'generatedAnswer',
+    [InsightEvents.expandToFullUI]: 'interface',
+    [InsightEvents.openUserActions]: 'User Actions',
+    [InsightEvents.showPrecedingSessions]: 'User Actions',
+    [InsightEvents.showFollowingSessions]: 'User Actions',
+    [InsightEvents.clickViewedDocument]: 'User Actions',
+    [InsightEvents.clickPageView]: 'User Actions',
+    [InsightEvents.createArticle]: 'createArticle',
 };
 
 class NoopAnalytics {
@@ -3074,6 +3076,9 @@ class CoveoInsightClient {
     logPageViewClick(pageView, metadata) {
         return this.logCustomEvent(InsightEvents.clickPageView, Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), { pageView }));
     }
+    logCreateArticle(createArticleMetadata, metadata) {
+        return this.logCustomEvent(InsightEvents.createArticle, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), createArticleMetadata) : createArticleMetadata);
+    }
     logDocumentOpen(info, identifier, metadata) {
         return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
     }

package/dist/library.js

@@ -731,7 +731,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.28.21" ;
+var libVersion = "2.28.22" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84203,6 +84203,7 @@ exports.InsightEvents = void 0;
     InsightEvents["showFollowingSessions"] = "showFollowingSessions";
     InsightEvents["clickViewedDocument"] = "clickViewedDocument";
     InsightEvents["clickPageView"] = "clickPageView";
+    InsightEvents["createArticle"] = "createArticle";
 })(exports.InsightEvents || (exports.InsightEvents = {}));
 
 var _a;
@@ -84325,12 +84326,6 @@ var CustomEventsTypes = (_a = {},
     _a[exports.SearchPageEvents.recentResultClick] = 'recentlyClickedDocuments',
     _a[exports.SearchPageEvents.clearRecentResults] = 'recentlyClickedDocuments',
     _a[exports.SearchPageEvents.showLessFoldedResults] = 'folding',
-    _a[exports.InsightEvents.expandToFullUI] = 'interface',
-    _a[exports.InsightEvents.openUserActions] = 'User Actions',
-    _a[exports.InsightEvents.showPrecedingSessions] = 'User Actions',
-    _a[exports.InsightEvents.showFollowingSessions] = 'User Actions',
-    _a[exports.InsightEvents.clickViewedDocument] = 'User Actions',
-    _a[exports.InsightEvents.clickPageView] = 'User Actions',
     _a[exports.SearchPageEvents.caseDetach] = 'case',
     _a[exports.SearchPageEvents.likeGeneratedAnswer] = 'generatedAnswer',
     _a[exports.SearchPageEvents.dislikeGeneratedAnswer] = 'generatedAnswer',
@@ -84341,6 +84336,13 @@ var CustomEventsTypes = (_a = {},
     _a[exports.SearchPageEvents.generatedAnswerHideAnswers] = 'generatedAnswer',
     _a[exports.SearchPageEvents.generatedAnswerShowAnswers] = 'generatedAnswer',
     _a[exports.SearchPageEvents.generatedAnswerFeedbackSubmit] = 'generatedAnswer',
+    _a[exports.InsightEvents.expandToFullUI] = 'interface',
+    _a[exports.InsightEvents.openUserActions] = 'User Actions',
+    _a[exports.InsightEvents.showPrecedingSessions] = 'User Actions',
+    _a[exports.InsightEvents.showFollowingSessions] = 'User Actions',
+    _a[exports.InsightEvents.clickViewedDocument] = 'User Actions',
+    _a[exports.InsightEvents.clickPageView] = 'User Actions',
+    _a[exports.InsightEvents.createArticle] = 'createArticle',
     _a);
 
 var NoopAnalytics = (function () {
@@ -86062,6 +86064,9 @@ var CoveoInsightClient = (function () {
     CoveoInsightClient.prototype.logPageViewClick = function (pageView, metadata) {
         return this.logCustomEvent(exports.InsightEvents.clickPageView, __assign(__assign({}, generateMetadataToSend(metadata, false)), { pageView: pageView }));
     };
+    CoveoInsightClient.prototype.logCreateArticle = function (createArticleMetadata, metadata) {
+        return this.logCustomEvent(exports.InsightEvents.createArticle, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), createArticleMetadata) : createArticleMetadata);
+    };
     CoveoInsightClient.prototype.logDocumentOpen = function (info, identifier, metadata) {
         return this.logClickEvent(exports.SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
     };

package/dist/library.mjs

@@ -729,7 +729,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.28.21" ;
+var libVersion = "2.28.22" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84201,6 +84201,7 @@ var InsightEvents;
     InsightEvents["showFollowingSessions"] = "showFollowingSessions";
     InsightEvents["clickViewedDocument"] = "clickViewedDocument";
     InsightEvents["clickPageView"] = "clickPageView";
+    InsightEvents["createArticle"] = "createArticle";
 })(InsightEvents || (InsightEvents = {}));
 
 var _a;
@@ -84323,12 +84324,6 @@ var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.recentResultClick] = 'recentlyClickedDocuments',
     _a[SearchPageEvents.clearRecentResults] = 'recentlyClickedDocuments',
     _a[SearchPageEvents.showLessFoldedResults] = 'folding',
-    _a[InsightEvents.expandToFullUI] = 'interface',
-    _a[InsightEvents.openUserActions] = 'User Actions',
-    _a[InsightEvents.showPrecedingSessions] = 'User Actions',
-    _a[InsightEvents.showFollowingSessions] = 'User Actions',
-    _a[InsightEvents.clickViewedDocument] = 'User Actions',
-    _a[InsightEvents.clickPageView] = 'User Actions',
     _a[SearchPageEvents.caseDetach] = 'case',
     _a[SearchPageEvents.likeGeneratedAnswer] = 'generatedAnswer',
     _a[SearchPageEvents.dislikeGeneratedAnswer] = 'generatedAnswer',
@@ -84339,6 +84334,13 @@ var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.generatedAnswerHideAnswers] = 'generatedAnswer',
     _a[SearchPageEvents.generatedAnswerShowAnswers] = 'generatedAnswer',
     _a[SearchPageEvents.generatedAnswerFeedbackSubmit] = 'generatedAnswer',
+    _a[InsightEvents.expandToFullUI] = 'interface',
+    _a[InsightEvents.openUserActions] = 'User Actions',
+    _a[InsightEvents.showPrecedingSessions] = 'User Actions',
+    _a[InsightEvents.showFollowingSessions] = 'User Actions',
+    _a[InsightEvents.clickViewedDocument] = 'User Actions',
+    _a[InsightEvents.clickPageView] = 'User Actions',
+    _a[InsightEvents.createArticle] = 'createArticle',
     _a);
 
 var NoopAnalytics = (function () {
@@ -86060,6 +86062,9 @@ var CoveoInsightClient = (function () {
     CoveoInsightClient.prototype.logPageViewClick = function (pageView, metadata) {
         return this.logCustomEvent(InsightEvents.clickPageView, __assign(__assign({}, generateMetadataToSend(metadata, false)), { pageView: pageView }));
     };
+    CoveoInsightClient.prototype.logCreateArticle = function (createArticleMetadata, metadata) {
+        return this.logCustomEvent(InsightEvents.createArticle, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), createArticleMetadata) : createArticleMetadata);
+    };
     CoveoInsightClient.prototype.logDocumentOpen = function (info, identifier, metadata) {
         return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
     };

package/dist/react-native.es.js

@@ -658,7 +658,7 @@ const addPageViewToHistory = (pageViewValue) => __awaiter(void 0, void 0, void 0
     yield store.addElementAsync(historyElement);
 });
 
-const libVersion = "2.28.21" ;
+const libVersion = "2.28.22" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1710,6 +1710,7 @@ var InsightEvents;
     InsightEvents["showFollowingSessions"] = "showFollowingSessions";
     InsightEvents["clickViewedDocument"] = "clickViewedDocument";
     InsightEvents["clickPageView"] = "clickPageView";
+    InsightEvents["createArticle"] = "createArticle";
 })(InsightEvents || (InsightEvents = {}));
 
 var SearchPageEvents;
@@ -1831,12 +1832,6 @@ const CustomEventsTypes = {
     [SearchPageEvents.recentResultClick]: 'recentlyClickedDocuments',
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
     [SearchPageEvents.showLessFoldedResults]: 'folding',
-    [InsightEvents.expandToFullUI]: 'interface',
-    [InsightEvents.openUserActions]: 'User Actions',
-    [InsightEvents.showPrecedingSessions]: 'User Actions',
-    [InsightEvents.showFollowingSessions]: 'User Actions',
-    [InsightEvents.clickViewedDocument]: 'User Actions',
-    [InsightEvents.clickPageView]: 'User Actions',
     [SearchPageEvents.caseDetach]: 'case',
     [SearchPageEvents.likeGeneratedAnswer]: 'generatedAnswer',
     [SearchPageEvents.dislikeGeneratedAnswer]: 'generatedAnswer',
@@ -1847,6 +1842,13 @@ const CustomEventsTypes = {
     [SearchPageEvents.generatedAnswerHideAnswers]: 'generatedAnswer',
     [SearchPageEvents.generatedAnswerShowAnswers]: 'generatedAnswer',
     [SearchPageEvents.generatedAnswerFeedbackSubmit]: 'generatedAnswer',
+    [InsightEvents.expandToFullUI]: 'interface',
+    [InsightEvents.openUserActions]: 'User Actions',
+    [InsightEvents.showPrecedingSessions]: 'User Actions',
+    [InsightEvents.showFollowingSessions]: 'User Actions',
+    [InsightEvents.clickViewedDocument]: 'User Actions',
+    [InsightEvents.clickPageView]: 'User Actions',
+    [InsightEvents.createArticle]: 'createArticle',
 };
 
 class NoopAnalytics {
@@ -3095,6 +3097,9 @@ class CoveoInsightClient {
     logPageViewClick(pageView, metadata) {
         return this.logCustomEvent(InsightEvents.clickPageView, Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), { pageView }));
     }
+    logCreateArticle(createArticleMetadata, metadata) {
+        return this.logCustomEvent(InsightEvents.createArticle, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), createArticleMetadata) : createArticleMetadata);
+    }
     logDocumentOpen(info, identifier, metadata) {
         return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.28.21",
+    "version": "2.28.22",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.cjs",
     "module": "dist/browser.mjs",

package/src/insight/insightClient.spec.ts

@@ -622,6 +622,15 @@ describe('InsightClient', () => {
             await client.logGeneratedAnswerStreamEnd(exampleGeneratedAnswerMetadata);
             expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerStreamEnd, exampleGeneratedAnswerMetadata);
         });
+
+        it('should send proper payload for #createArticle', async () => {
+            const exampleCreateArticleMetadata = {
+                articleType: 'Knowledge__kav',
+                triggeredBy: 'CreateArticleButton',
+            };
+            await client.logCreateArticle(exampleCreateArticleMetadata);
+            expectMatchCustomEventPayload(InsightEvents.createArticle, exampleCreateArticleMetadata);
+        });
     });
 
     describe('when the case metadata is included', () => {
@@ -1380,6 +1389,19 @@ describe('InsightClient', () => {
             await client.logGeneratedAnswerStreamEnd(exampleGeneratedAnswerMetadata, baseCaseMetadata);
             expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerStreamEnd, expectedMetadata);
         });
+
+        it.only('should send proper payload for #createArticle', async () => {
+            const exampleCreateArticleMetadata = {
+                articleType: 'Knowledge__kav',
+                triggeredBy: 'CreateArticleButton',
+            };
+            const expectedMetadata = {
+                ...exampleCreateArticleMetadata,
+                ...expectedBaseCaseMetadata,
+            };
+            await client.logCreateArticle(exampleCreateArticleMetadata, baseCaseMetadata);
+            expectMatchCustomEventPayload(InsightEvents.createArticle, expectedMetadata);
+        });
     });
 
     it('should enable analytics tracking by default', () => {

package/src/insight/insightClient.ts

@@ -35,6 +35,7 @@ import {
     InsightResultsSortMetadata,
     UserActionsDocumentMetadata,
     UserActionsPageViewMetadata,
+    CreateArticleMetadata,
 } from './insightEvents';
 
 export interface InsightClientProvider {
@@ -266,6 +267,13 @@ export class CoveoInsightClient {
         });
     }
 
+    public logCreateArticle(createArticleMetadata: CreateArticleMetadata, metadata?: CaseMetadata) {
+        return this.logCustomEvent(
+            InsightEvents.createArticle,
+            metadata ? {...generateMetadataToSend(metadata, false), ...createArticleMetadata} : createArticleMetadata
+        );
+    }
+
     public logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata) {
         return this.logClickEvent(
             SearchPageEvents.documentOpen,

package/src/insight/insightEvents.ts

@@ -40,6 +40,10 @@ export enum InsightEvents {
      * Identifies the event that gets logged when the user clicks a viewed page link on the user actions timeline.
      */
     clickPageView = 'clickPageView',
+    /**
+     * Identifies the event that gets logged when the user clicks the create article button.
+     */
+    createArticle = 'createArticle',
 }
 
 export interface CaseMetadata {
@@ -66,6 +70,11 @@ export interface UserActionsPageViewMetadata {
     contentIdValue: string;
 }
 
+export interface CreateArticleMetadata {
+    articleType: string;
+    triggeredBy: string;
+}
+
 export interface InsightInterfaceChangeMetadata extends InterfaceChangeMetadata, CaseMetadata {}
 
 export interface InsightFacetMetadata extends FacetMetadata, CaseMetadata {}

package/src/searchPage/searchPageEvents.ts

@@ -373,12 +373,6 @@ export const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents,
     [SearchPageEvents.recentResultClick]: 'recentlyClickedDocuments',
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
     [SearchPageEvents.showLessFoldedResults]: 'folding',
-    [InsightEvents.expandToFullUI]: 'interface',
-    [InsightEvents.openUserActions]: 'User Actions',
-    [InsightEvents.showPrecedingSessions]: 'User Actions',
-    [InsightEvents.showFollowingSessions]: 'User Actions',
-    [InsightEvents.clickViewedDocument]: 'User Actions',
-    [InsightEvents.clickPageView]: 'User Actions',
     [SearchPageEvents.caseDetach]: 'case',
     [SearchPageEvents.likeGeneratedAnswer]: 'generatedAnswer',
     [SearchPageEvents.dislikeGeneratedAnswer]: 'generatedAnswer',
@@ -389,6 +383,13 @@ export const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents,
     [SearchPageEvents.generatedAnswerHideAnswers]: 'generatedAnswer',
     [SearchPageEvents.generatedAnswerShowAnswers]: 'generatedAnswer',
     [SearchPageEvents.generatedAnswerFeedbackSubmit]: 'generatedAnswer',
+    [InsightEvents.expandToFullUI]: 'interface',
+    [InsightEvents.openUserActions]: 'User Actions',
+    [InsightEvents.showPrecedingSessions]: 'User Actions',
+    [InsightEvents.showFollowingSessions]: 'User Actions',
+    [InsightEvents.clickViewedDocument]: 'User Actions',
+    [InsightEvents.clickPageView]: 'User Actions',
+    [InsightEvents.createArticle]: 'createArticle',
 };
 
 export interface StaticFilterMetadata {