@coveo/usage-analytics-event-types 0.0.0 → 6.24.1

package/package.json

@@ -1,11 +1,24 @@
 {
   "name": "@coveo/usage-analytics-event-types",
-  "version": "0.0.0",
-  "description": "",
+  "version": "6.24.1",
+  "description": "Typescript types for Coveo Usage Analytics Events",
+  "types": "./usage-analytics-types.d.ts",
+  "author": "Coveo",
+  "license": "Apache-2.0",
+  "keywords": [
+    "Coveo",
+    "analytics",
+    "event",
+    "types"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/coveo/analytics_schema.git"
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "Apache-2.0"
+  }
 }

package/usage-analytics-types.d.ts

@@ -0,0 +1,768 @@
+/**
+ * Copyright (c) Coveo Solutions Inc. These types are automatically generated. Do not modify manually!
+ */
+
+/**
+ * Standardized currency type for commerce.
+ */
+type Currency = string | number;
+
+/**
+ * List of supported currencies.
+ */
+type CurrencyCodeISO4217 = "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTC" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNH" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VES" | "VND" | "VUV" | "WST" | "XAF" | "XAG" | "XAU" | "XCD" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "YER" | "ZAR" | "ZMW" | "ZWL";
+
+/**
+ * ISO693-1 language code.
+ */
+type LanguageISO639 = string | null;
+
+/**
+ * ISO693-1 language codes supported by Coveo.
+ */
+type SupportedLanguageISO639 = string;
+
+/**
+ * Tracking identifier.
+ */
+type TrackingId = string | null;
+
+/**
+ * Unix epoch timestamp, represented in milliseconds.
+ */
+type UnixTimestampWithMs = number;
+
+/**
+ * A UUID which cannot be null.
+ */
+type UuidNotNull = string;
+
+/**
+ * A UUID which can be null.
+ */
+type UuidNull = string | null;
+
+/**
+ * The facet state information in JSON ARRAY format at the time the search operation was performed.
+ */
+interface FacetState {
+    /**
+     * The facet field.
+     */
+    field: string;
+    /**
+     * The unique identifier of the facet in the search interface. Must match the regex "^[a-zA-Z0-9@\-_]{1,60}$".
+     */
+    id: string;
+    /**
+     * The name of the facet value.
+     */
+    value: string;
+    /**
+     * The display name of the facet value that was interacted with.
+     */
+    displayValue?: string;
+    /**
+     * The facet action type.
+     */
+    state: "auto_selected" | "selected" | "excluded";
+    /**
+     * The facet data type.
+     */
+    facetType: string;
+    /**
+     * The 1-based position of the facet.
+     */
+    facetPosition?: number;
+    /**
+     * The 1-based position of the value in the facet
+     */
+    valuePosition?: number;
+    /**
+     * The facet title.
+     */
+    title?: string;
+}
+
+interface SearchResult {
+    /**
+     * The @sysuri of this item.
+     */
+    documentUri: string;
+    /**
+     * The @sysurihash of this item.
+     */
+    documentUriHash: string;
+}
+
+/**
+ * UA analytics click request
+ */
+export interface UsageAnalyticsClick {
+    actionCause: "interfaceLoad" | "interfaceChange" | "contextRemove" | "didyoumeanAutomatic" | "didyoumeanClick" | "resultsSort" | "searchboxSubmit" | "searchboxClear" | "searchboxAsYouType" | "breadcrumbFacet" | "breadcrumbAdvancedSearch" | "breadcrumbResetAll" | "documentTag" | "documentField" | "documentQuickview" | "documentOpen" | "omniboxFacetSelect" | "omniboxFacetExclude" | "omniboxFacetDeselect" | "omniboxFacetUnexclude" | "omniboxAnalytics" | "omniboxFromLink" | "omniboxField" | "facetClearAll" | "facetSearch" | "facetToggle" | "facetRangeSlider" | "facetRangeGraph" | "facetSelect" | "facetSelectAll" | "facetDeselect" | "facetExclude" | "facetUnexclude" | "facetUpdateSort" | "showMoreFacetResults" | "showLessFacetResults" | "categoryFacetSelect" | "categoryFacetReload" | "categoryFacetClear" | "categoryFacetBreadcrumb" | "categoryFacetSearch" | "errorBack" | "errorClearQuery" | "errorRetry" | "noResultsBack" | "expandToFullUI" | "inputChange" | "submitButton" | "cancelButton" | "unloadPage" | "casecontextAdd" | "casecontextRemove" | "contextChanged" | "preferencesChange" | "getUserHistory" | "userActionDocumentClick" | "caseAttach" | "caseDetach" | "customfiltersChange" | "pagerNumber" | "pagerNext" | "pagerPrevious" | "pagerScrolling" | "pagerResize" | "positionSet" | "searchFromLink" | "notify" | "execute" | "query" | "redirect" | "exportToExcel" | "recommendation" | "recommendationInterfaceLoad" | "recommendationOpen" | "advancedSearch" | "followDocument" | "followQuery" | "updateSubscription" | "deleteSubscription" | "unfollowDocument" | "unfollowQuery" | "selectValue" | "deselectValue" | "clearAll" | "changeResultsLayout" | "showMoreFoldedResults" | "showLessFoldedResults" | "addMissingTerm" | "removeMissingTerm" | "showQuerySuggestPreview" | "clickQuerySuggestPreview" | "likeSmartSnippet" | "dislikeSmartSnippet" | "expandSmartSnippet" | "collapseSmartSnippet" | "openSmartSnippetFeedbackModal" | "closeSmartSnippetFeedbackModal" | "sendSmartSnippetReason" | "openSmartSnippetSource" | "expandSmartSnippetSuggestion" | "collapseSmartSnippetSuggestion" | "openSmartSnippetSuggestionSource" | "staticFilterClearAll" | "staticFilterSelect" | "staticFilterDeselect" | "recentQueriesClick" | "clearRecentQueries" | "recentResultClick" | "clearRecentResults" | "copyToClipboard" | "topQueriesClick" | "userActionLoad" | "userActionsSubmit" | "openUserActions" | "historyBackward" | "enterOnSearchbox" | "quickviewLoaded" | "openQuickview" | "sendAsEmail" | "postToFeed" | "sendToLiveAgent" | "attachToCaseStateChanged" | "attachedResultsLoad" | "CaseInputChange" | "attachedResultsChange" | "openSmartSnippetInlineLink" | "openSmartSnippetSuggestionInlineLink" | "Case.SendEmail" | "FeedItem.TextPost";
+    /**
+     * The 1-based index position of the item that was clicked in the result list. This number must take into consideration pagination settings. If the pages contain ten results each, the third item of the second page is at the position 23.
+     */
+    documentPosition: number;
+    /**
+     * The @uri of the item that was clicked.
+     */
+    documentUri?: string | null;
+    /**
+     * The @urihash of the item that was clicked.
+     */
+    documentUriHash: string;
+    /**
+     * The content language. Prefix must be a valid ISO 639-1 code.
+     */
+    language: SupportedLanguageISO639;
+    /**
+     * The unique identifier of the event which led the search interface to log the click event. It is recommend to use the searchUid in the response of the corresponding search request to the Search API, or any UUID v4 of length less than or equal to 36 characters. UUIDs longer than 36 characters are truncated by the service. This must be a valid searchQueryUid for an event that contains the provided documentUri and documentUriHash.
+     */
+    searchQueryUid: UuidNotNull;
+    /**
+     * The @source of the item that was clicked.
+     */
+    sourceName: string;
+    /**
+     * Whether the interaction that caused the search interface to log the event was triggered by an anonymous user.  If set to true, the Usage Analytics Write API will not extract the name and userDisplayName, if present, from the search token.
+     */
+    anonymous?: boolean;
+    /**
+     * A value that uniquely identifies the browser which is logging the event. Must be a valid UUID.
+     */
+    clientId: UuidNotNull;
+    /**
+     * The @syscollection of the item that was clicked.
+     */
+    collectionName?: string | null;
+    /**
+     * The author of the item that was clicked.
+     */
+    documentAuthor?: string | null;
+    /**
+     * The category of the item that was clicked.
+     */
+    documentCategory?: string | null;
+    /**
+     * The title of the item that was clicked.
+     */
+    documentTitle?: string | null;
+    /**
+     * The url of the item that was clicked.
+     */
+    documentUrl?: string | null;
+    /**
+     * The origin of the event. Used to specify the deployment from which the user performs the action.
+     */
+    originContext?: string | null;
+    /**
+     * The name/identifier of the search interface from which the event originates.
+     */
+    originLevel1?: string | null;
+    /**
+     * The name/identifier of the tab from which the event originates.
+     */
+    originLevel2?: string | null;
+    /**
+     * The URL of the page that redirected the browser to the search interface from which the event originates.
+     */
+    originLevel3?: string | null;
+    /**
+     * An indication of how good the outcome of this event is. No longer in use.
+     */
+    outcome?: number | null;
+    /**
+     * The name of the query pipeline which processed the query that led to the click event.
+     */
+    queryPipeline?: string | null;
+    /**
+     * The ranking modifier that affected the clicked item.
+     */
+    rankingModifier?: string | null;
+    /**
+     * The name of the A/B test run, if one is active.
+     */
+    splitTestRunName?: string | null;
+    /**
+     * The version of the A/B test run, if one is active.
+     */
+    splitTestRunVersion?: string | null;
+    /**
+     * Information about the browser and operating system of the end-user who caused the search interface to log an event.
+     */
+    userAgent?: string;
+    /**
+     * The display name of the user performing the event.
+     */
+    userDisplayName?: string | null;
+    /**
+     * The name of the user security identity who caused the search interface to log the event.
+     */
+    username?: string | null;
+    /**
+     * The user defined dimensions and their values. Keys can only contain alphanumeric or underscore characters. Whitespaces in keys are converted to underscores. Uppercase characters in keys are converted to lowercase characters. The value could be any valid JSON, but it is handled as string over Coveo usage analytics. It is highly recommended that you create your custom dimension before adding customData.
+     */
+    customData?: {
+        [index: string]: unknown;
+    } | null;
+    /**
+     * The trackingId for your analytics event. A string that consists of one or more characters that are lowercase letters (a-z), uppercase letters (A-Z), digits (0-9), underscores (_), dash (-) or dot (.), and does not allow any other characters.
+     */
+    trackingId?: TrackingId;
+}
+
+export interface UsageAnalyticsCollect {
+    /**
+     * The protocol version for all hit types. The current value is 1.
+     */
+    v?: string;
+    /**
+     * The tracking or web property ID for all hit types. The tid is the org query parameter in a Coveo search interface. For more information, see Log Usage Analytics Events.
+     */
+    tid?: string;
+    /**
+     * Whether the IP address of the sender is anonymized.
+     */
+    aip?: boolean | string | number;
+    /**
+     * Whether an event is marked as disabled for advertising personalization, including for events from a property with a setting that otherwise permits ads personalization.
+     */
+    npa?: boolean;
+    /**
+     * Indicates the data source of the hit. E.g. 'web' or 'app'.
+     */
+    ds?: string | null;
+    /**
+     * Collects offline and latent hits.
+     */
+    qt?: number;
+    /**
+     * Indicates the name or identifier of the search interface from which the query originated. Forwards to 'originLevel1'.
+     */
+    searchHub?: string | null;
+    /**
+     * The ranking modifier that affected the clicked item.
+     */
+    rankingModifier?: string | null;
+    /**
+     * Indicates the name or identifier of the selected tab from which the query originated. Forwards to 'originLevel2'.
+     */
+    tab?: string | null;
+    /**
+     * Sends a random number in GET requests to ensure browsers and proxies don’t cache hits. This value is not used in reporting.
+     */
+    z?: string | null;
+    /**
+     * Pseudonymously identifies a particular browser or app instance.
+     */
+    cid: UuidNotNull;
+    /**
+     * Represents the user ID and identifies a user through the credentials used to log in to a certain website (e.g., the user’s hashed email address).
+     */
+    uid?: string | null;
+    /**
+     * Controls the session duration. Values of 'start' and 'end' are used.
+     */
+    sc?: "start" | "end";
+    /**
+     * Represents the IP address of the user. When specified, Coveo uses this IP address. Otherwise, it uses the IP address from the request, the same as UA events. In the UA report, an IP address from the Collect endpoint or a UA event is hashed in the same way (results into the same non-reversible hash value). The following dimensions are determined with the IP address: City, Country, and Region. For more information about IP addresses, see Analytics Data.
+     */
+    uip?: string;
+    /**
+     * Represents the user agent of the browser. It works in the same way as userAgent in UA events.
+     */
+    ua?: string | null;
+    /**
+     * Provides the geographical location of the user. The geographical ID should be a two-letter country code or a criteria ID representing a city or region.
+     */
+    geoid?: string | null;
+    /**
+     * Specifies the document referral source which brought traffic to a website. Maximum length of 2048 bytes. It’s also used to compute the traffic source and works in the same way as originLevel3 in UA events.
+     */
+    dr?: string | null;
+    /**
+     * Specifies the campaign name.
+     */
+    cn?: string | null;
+    /**
+     * Specifies the campaign source.
+     */
+    cs?: string | null;
+    /**
+     * Specifies the campaign medium.
+     */
+    cm?: string | null;
+    /**
+     * Specifies the campaign keyword.
+     */
+    ck?: string | null;
+    /**
+     * Specifies the campaign content.
+     */
+    cc?: string | null;
+    /**
+     * Specifies the campaign id.
+     */
+    ci?: string | null;
+    /**
+     * Specifies the screen resolution. Maximum length of 20 bytes. It must use the following format: <INTEGER>x<INTEGER>. Both integers have a positive value (e.g., 1280x1024). The x isn’t case-sensitive and a space is allowed before and after.
+     */
+    sr?: string | null;
+    /**
+     * Specifies the viewport size of the browser or device.
+     */
+    vp?: string | null;
+    /**
+     * Specifies the character set used to encode the page or the document. Maximum length of 20 bytes.
+     */
+    de?: string | null;
+    /**
+     * Specifies the screen color depth. Maximum length of 20 bytes.
+     */
+    sd?: string | null;
+    /**
+     * Specifies the locale setting of the user’s browser. Automatically sent using Coveo’s libraries and is specified with ISO-639 standards (e.g., 'en-us').
+     */
+    ul?: LanguageISO639;
+    /**
+     * Specifies if Java is enabled.
+     */
+    je?: boolean;
+    /**
+     * Specifies the Flash version.
+     */
+    fl?: string | null;
+    /**
+     * This must be one of the following: pageview, screenview, event, transaction, item, social, or timing. The Collect event is converted to a UA event based on this value. The original event from the Collect endpoint is then stored as a UA event as custom_datas, under the c_original_event_data attribute name. UA dimensions can be then used to access those parameters over UA reports.
+     */
+    t: "pageview" | "screenview" | "event" | "transaction" | "item" | "social" | "timing";
+    /**
+     * Specifies if a hit is non-interactive
+     */
+    ni?: boolean;
+    /**
+     * Identifies a unique page load. Randomly generated on a pageview.
+     */
+    pid?: UuidNotNull;
+    /**
+     * Sends the document location URL of the page on which the content resides. Maximum length of 2048 bytes. You can use the dh and dp parameters to override the host name, path, and query portions of the document location accordingly. Based on the event type, the document URL is converted to either a view, search, or click event.
+     */
+    dl?: string | null;
+    /**
+     * Specifies the document host name from which the content is hosted. Maximum length of 2048 bytes. If converted to a UA view event and the dl is empty, then the location becomes the concatenation of the dh and dp parameters.
+     */
+    dh?: string | null;
+    /**
+     * Represents the document path portion of the page URL. Starts with a slash.
+     */
+    dp?: string | null;
+    /**
+     * Represents the document title.
+     */
+    dt?: string | null;
+    /**
+     * Describes the content of a screenview hit on mobile.
+     */
+    cd?: string | null;
+    /**
+     * The ID of a clicked DOM element, used to disambiguate multiple links to the same URL.
+     */
+    linkid?: string | null;
+    /**
+     * Specifies the application name.
+     */
+    an?: string | null;
+    /**
+     * Application identifier.
+     */
+    aid?: string | null;
+    /**
+     * Specifies the application version.
+     */
+    av?: string | null;
+    /**
+     * Application installer identifier.
+     */
+    aiid?: string | null;
+    /**
+     * Specifies the event category. Must not be empty.
+     */
+    ec?: string;
+    /**
+     * Specifies the event action. Must not be empty.
+     */
+    ea?: string;
+    /**
+     * Specifies the event label.
+     */
+    el?: string | null;
+    /**
+     * Specifies the event value. Values must be non-negative.
+     */
+    ev?: number | null;
+    /**
+     * A unique identifier for the transaction. This value should be the same for both the Transaction hit and Items hits associated to the particular transaction.
+     */
+    ti?: string | null;
+    /**
+     * Specifies the affiliation or store name.
+     */
+    ta?: string | null;
+    /**
+     * Specifies the total revenue associated with the transaction. This value should include any shipping or tax costs.
+     */
+    tr?: Currency;
+    /**
+     * Specifies the total shipping cost of the transaction.
+     */
+    ts?: Currency;
+    /**
+     * Specifies the total tax of the transaction.
+     */
+    tt?: Currency;
+    /**
+     * Specifies the item name. Required for item hit type.
+     */
+    in?: string | null;
+    /**
+     * Specifies the price for a single item / unit.
+     */
+    ip?: Currency;
+    /**
+     * Specifies the number of items purchased.
+     */
+    iq?: number;
+    /**
+     * Specifies the SKU or item code.
+     */
+    ic?: string | null;
+    /**
+     * Specifies the category that the item belongs to.
+     */
+    iv?: string | null;
+    /**
+     * The role of the products included in a hit.
+     */
+    pa?: "detail" | "click" | "add" | "remove" | "checkout" | "checkout_option" | "purchase" | "refund" | "impression" | "quickview" | "bookmark_add" | "bookmark_remove" | "compare_add" | "compare_remove" | "review_add" | "review_remove" | "quote";
+    /**
+     * The transaction coupon redeemed with the transaction. This is an additional parameter that can be sent when Product Action is set to 'purchase' or 'refund'.
+     */
+    tcc?: string | null;
+    /**
+     * The list or collection from which a product action occurred. This is an additional parameter that can be sent when Product Action is set to 'detail' or 'click'.
+     */
+    pal?: string | null;
+    /**
+     * The step number in a checkout funnel. This is an additional parameter that can be sent when Product Action is set to 'checkout'.
+     */
+    cos?: number;
+    /**
+     * Additional information about a checkout step. This is an additional parameter that can be sent when Product Action is set to 'checkout'.
+     */
+    col?: string | null;
+    /**
+     * Specifies the role of the promotions included in a hit.
+     */
+    promoa?: string | null;
+    /**
+     * When present indicates the local currency for all transaction currency values.
+     */
+    cu?: CurrencyCodeISO4217;
+    /**
+     * Client side event timestamp. Collect protocol specific.
+     */
+    tm?: UnixTimestampWithMs;
+    /**
+     * Used by service integrations specifically to forward the custom event type, e.g. 'ticket_field_update'.
+     */
+    svc_action?: string;
+    /**
+     * The trackingId for your analytics event. A string that consists of one or more characters that are lowercase letters (a-z), uppercase letters (A-Z), digits (0-9), underscores (_), dash (-) or dot (.), and does not allow any other characters.
+     */
+    trackingId?: TrackingId;
+    [index: string]: unknown;
+}
+
+/**
+ * UA analytics custom request
+ */
+export interface UsageAnalyticsCustom {
+    /**
+     * The custom event type.
+     */
+    eventType: string;
+    /**
+     * The custom event value.
+     */
+    eventValue: string;
+    /**
+     * The content language. Prefix must be a valid ISO 639-1 code.
+     */
+    language: SupportedLanguageISO639;
+    /**
+     * Whether the interaction that caused the search interface to log the event was triggered by an anonymous user.  If set to 'true', the Usage Analytics Write API will not extract the name and userDisplayName, if present, from the search token.
+     */
+    anonymous?: boolean;
+    /**
+     * A value that uniquely identifies the browser which is logging the event. Must be a valid UUID.
+     */
+    clientId: UuidNotNull;
+    /**
+     * The user defined dimensions and their values. Keys can only contain alphanumeric or underscore characters. Whitespaces in keys are converted to underscores. Uppercase characters in keys are converted to lowercase characters. The value could be any valid JSON, but it is handled as string over Coveo usage analytics. It is highly recommended that you create your custom dimension before adding customData.
+     */
+    customData?: {
+        [index: string]: unknown;
+    } | null;
+    /**
+     * The unique identifier (typically, the searchUid) of the query that caused the search interface to log the custom event, if applicable.
+     */
+    lastSearchQueryUid?: UuidNull;
+    /**
+     * The origin of the event. Used to specify the deployment from which the user performs the action.
+     */
+    originContext?: string | null;
+    /**
+     * The name/identifier of the search interface from which the event originates.
+     */
+    originLevel1?: string | null;
+    /**
+     * The name/identifier of the tab from which the event originates.
+     */
+    originLevel2?: string | null;
+    /**
+     * The URL of the page that redirected the browser to the search interface from which the event originates.
+     */
+    originLevel3?: string | null;
+    /**
+     * An indication of how good the outcome of this event is.
+     */
+    outcome?: number | null;
+    /**
+     * The name of the A/B test run, if one is active.
+     */
+    splitTestRunName?: string | null;
+    /**
+     * The version of the A/B test run, if one is active.
+     */
+    splitTestRunVersion?: string | null;
+    /**
+     * Information about the browser and operating system of the end-user who caused the search interface to log an event.
+     */
+    userAgent?: string | null;
+    /**
+     * The display name of the user performing the event.
+     */
+    userDisplayName?: string | null;
+    /**
+     * The name of the user security identity who caused the search interface to log the event.
+     */
+    username?: string | null;
+    /**
+     * The trackingId for your analytics event. A string that consists of one or more characters that are lowercase letters (a-z), uppercase letters (A-Z), digits (0-9), underscores (_), dash (-) or dot (.), and does not allow any other characters.
+     */
+    trackingId?: TrackingId;
+}
+
+/**
+ * UA analytics search request
+ */
+export interface UsageAnalyticsSearch {
+    actionCause: "interfaceLoad" | "interfaceChange" | "contextRemove" | "didyoumeanAutomatic" | "didyoumeanClick" | "resultsSort" | "searchboxSubmit" | "searchboxClear" | "searchboxAsYouType" | "breadcrumbFacet" | "breadcrumbAdvancedSearch" | "breadcrumbResetAll" | "documentTag" | "documentField" | "documentQuickview" | "documentOpen" | "omniboxFacetSelect" | "omniboxFacetExclude" | "omniboxFacetDeselect" | "omniboxFacetUnexclude" | "omniboxAnalytics" | "omniboxFromLink" | "omniboxField" | "facetClearAll" | "facetSearch" | "facetToggle" | "facetRangeSlider" | "facetRangeGraph" | "facetSelect" | "facetSelectAll" | "facetDeselect" | "facetExclude" | "facetUnexclude" | "facetUpdateSort" | "showMoreFacetResults" | "showLessFacetResults" | "categoryFacetSelect" | "categoryFacetReload" | "categoryFacetClear" | "categoryFacetBreadcrumb" | "categoryFacetSearch" | "errorBack" | "errorClearQuery" | "errorRetry" | "noResultsBack" | "expandToFullUI" | "inputChange" | "submitButton" | "cancelButton" | "unloadPage" | "casecontextAdd" | "casecontextRemove" | "contextChanged" | "preferencesChange" | "getUserHistory" | "userActionDocumentClick" | "caseAttach" | "caseDetach" | "customfiltersChange" | "pagerNumber" | "pagerNext" | "pagerPrevious" | "pagerScrolling" | "pagerResize" | "positionSet" | "searchFromLink" | "notify" | "execute" | "query" | "redirect" | "exportToExcel" | "recommendation" | "recommendationInterfaceLoad" | "recommendationOpen" | "advancedSearch" | "followDocument" | "followQuery" | "updateSubscription" | "deleteSubscription" | "unfollowDocument" | "unfollowQuery" | "selectValue" | "deselectValue" | "clearAll" | "changeResultsLayout" | "showMoreFoldedResults" | "showLessFoldedResults" | "addMissingTerm" | "removeMissingTerm" | "showQuerySuggestPreview" | "clickQuerySuggestPreview" | "likeSmartSnippet" | "dislikeSmartSnippet" | "expandSmartSnippet" | "collapseSmartSnippet" | "openSmartSnippetFeedbackModal" | "closeSmartSnippetFeedbackModal" | "sendSmartSnippetReason" | "openSmartSnippetSource" | "expandSmartSnippetSuggestion" | "collapseSmartSnippetSuggestion" | "openSmartSnippetSuggestionSource" | "staticFilterClearAll" | "staticFilterSelect" | "staticFilterDeselect" | "recentQueriesClick" | "clearRecentQueries" | "recentResultClick" | "clearRecentResults" | "copyToClipboard" | "topQueriesClick" | "userActionLoad" | "userActionsSubmit" | "openUserActions" | "historyBackward" | "enterOnSearchbox" | "quickviewLoaded" | "openQuickview" | "sendAsEmail" | "postToFeed" | "sendToLiveAgent" | "attachToCaseStateChanged" | "attachedResultsLoad" | "CaseInputChange" | "attachedResultsChange" | "openSmartSnippetInlineLink" | "openSmartSnippetSuggestionInlineLink" | "retryGeneratedAnswer";
+    /**
+     * The content language. Prefix must be a valid ISO 639-1 code.
+     */
+    language: SupportedLanguageISO639;
+    /**
+     * The original basic query expression ('q') in the corresponding search request.
+     */
+    queryText: string;
+    /**
+     * The amount of time (in milliseconds) between the moment the query that caused the search interface to log a search event was sent to the Search API and the moment the Search API returned the results. Must be greater than zero.
+     */
+    responseTime: number;
+    /**
+     * It is recommended to use the searchUid in the response of the corresponding search request to the Search API, or any UUID v4 of length less than or equal to 36 characters. UUIDs longer than 36 characters are truncated by the service.
+     */
+    searchQueryUid: UuidNotNull;
+    /**
+     * The original advanced query expression ('aq') in the corresponding search request. Usually, this contains various query elements that were not manually added by the user.
+     */
+    advancedQuery?: string | null;
+    /**
+     * Whether the interaction that caused the search interface to log the event was triggered by an anonymous user.  If set to 'true', the Usage Analytics Write API will not extract the name and userDisplayName, if present, from the search token.
+     */
+    anonymous?: boolean;
+    /**
+     * A value that uniquely identifies the browser which is logging the event. Must be a valid UUID.
+     */
+    clientId: UuidNotNull;
+    /**
+     * Indicates if the query is modified by contextual filters (for instance, a query to find similar items).
+     */
+    contextual?: boolean;
+    /**
+     * The user defined dimensions and their values. Keys can only contain alphanumeric or underscore characters. Whitespaces in keys are converted to underscores. Uppercase characters in keys are converted to lowercase characters. The value could be any valid JSON, but it is handled as string over Coveo usage analytics. It is highly recommended that you create your custom dimension before adding customData. Notes: ml/qs and ml/pqs rely on suggestion metadata and ml/dne rely on additional facet metadata attached in customData.
+     */
+    customData?: {
+        [index: string]: unknown;
+    } | null;
+    facetState?: FacetState[] | null;
+    /**
+     * The index name the search query performed against.
+     */
+    indexId?: string | null;
+    /**
+     * The number of results which were returned by the query that caused the search interface to log a search event. Must be equal to or greater than zero.
+     */
+    numberOfResults?: number;
+    /**
+     * The origin of the event. Used to specify the deployment from which the user performs the action.
+     */
+    originContext?: string | null;
+    /**
+     * The name/identifier of the search interface from which the event originates.
+     */
+    originLevel1?: string | null;
+    /**
+     * The name/identifier of the tab from which the event originates.
+     */
+    originLevel2?: string | null;
+    /**
+     * The URL of the page that redirected the browser to the search interface from which the event originates.
+     */
+    originLevel3?: string | null;
+    /**
+     * An indication of how good the outcome of this event is. No longer in use.
+     */
+    outcome?: number | null;
+    /**
+     * The name of the query pipeline which processed the query that led to the search event.
+     */
+    queryPipeline?: string | null;
+    /**
+     * The results of this search event. Deprecated.
+     */
+    results?: SearchResult[] | null;
+    /**
+     * The name of the A/B test run, if one is active.
+     */
+    splitTestRunName?: string | null;
+    /**
+     * The version of the A/B test run, if one is active.
+     */
+    splitTestRunVersion?: string | null;
+    /**
+     * Information about the browser and operating system of the end-user who caused the search interface to log an event.
+     */
+    userAgent?: string | null;
+    /**
+     * The display name of the user performing the event.
+     */
+    userDisplayName?: string | null;
+    /**
+     * The groups that the end-user performing the event is a member of.
+     */
+    userGroups?: string[] | null;
+    /**
+     * The name of the user security identity who caused the search interface to log the event.
+     */
+    username?: string | null;
+    /**
+     * The trackingId for your analytics event. A string that consists of one or more characters that are lowercase letters (a-z), uppercase letters (A-Z), digits (0-9), underscores (_), dash (-) or dot (.), and does not allow any other characters.
+     */
+    trackingId?: TrackingId;
+}
+
+/**
+ * UA analytics view request
+ */
+export interface UsageAnalyticsView {
+    /**
+     * The content language. Prefix must be a valid ISO 639-1 code.
+     */
+    language?: SupportedLanguageISO639;
+    /**
+     * The URL of the viewed page or component, usually 'document.location.href'.
+     */
+    location: string;
+    /**
+     * Information about the browser and operating system of the end-user who caused the search interface to log an event.
+     */
+    userAgent?: string;
+    /**
+     * The user defined dimensions and their values.
+     */
+    customData?: {
+        [index: string]: unknown;
+    } | null;
+    /**
+     * Whether the interaction that caused the search interface to log the event was triggered by an anonymous user.
+     */
+    anonymous?: boolean;
+    /**
+     * The name of the user security identity who caused the search interface to log the event.
+     */
+    username?: string | null;
+    /**
+     * The display name of the user performing the event.
+     */
+    userDisplayName?: string | null;
+    /**
+     * The name of the A/B test run, if one is active.
+     */
+    splitTestRunName?: string | null;
+    /**
+     * The version of the A/B test run
+     */
+    splitTestRunVersion?: string | null;
+    /**
+     * The name/identifier of the search interface from which the event originates.
+     */
+    originLevel1?: string | null;
+    /**
+     * The name/identifier of the tab from which the event originates.
+     */
+    originLevel2?: string | null;
+    /**
+     * The URL of the page that redirected the browser to the search interface from which the event originates.
+     */
+    originLevel3?: string | null;
+    /**
+     * An indication of how good the outcome of this event is.
+     */
+    outcome?: number | null;
+    /**
+     * The origin of the event. Used to specify the deployment from which the user performs the action.
+     */
+    originContext?: string | null;
+    /**
+     * A value that uniquely identifies the browser which is logging the event. Must be a valid UUID.
+     */
+    clientId: UuidNotNull;
+    /**
+     * This parameter is exposed for backward compatibility reasons. Use originLevel3 instead.
+     */
+    referrer?: string | null;
+    /**
+     * The title of the item or page.
+     */
+    title?: string | null;
+    /**
+     * The name of a field in the index that identifies the item uniquely.
+     */
+    contentIdKey?: string | null;
+    /**
+     * The value of the field selected as contentIdKey.
+     */
+    contentIdValue?: string | null;
+    /**
+     * The type of content in the page.
+     */
+    contentType?: string | null;
+    /**
+     * The trackingId for your analytics event. A string that consists of one or more characters that are lowercase letters (a-z), uppercase letters (A-Z), digits (0-9), underscores (_), dash (-) or dot (.), and does not allow any other characters.
+     */
+    trackingId?: TrackingId;
+}
+