Interface ISearchEvent

Describes a Coveo Cloud usage analytics search event.

Index

Properties

actionCause

actionCause: string

A unique name describing the action that triggered the event.

See the name property of the IAnalyticsActionCause interface.

Example: pagerNext

actionType

actionType: string

A name describing the category of actions to which the action that triggered the event belongs.

See the type property of the IAnalyticsActionCause interface.

Example: getMoreResults

advancedQuery

advancedQuery: string

The original advanced query expression (i.e., aq) sent for the related query.

Note: The framework normally sets this field by retrieving the information from the related query.

Optional anonymous

anonymous: boolean

Whether the event should be logged anonymously to the Coveo Cloud usage analytics service.

Note: This field is normally set to the anonymous option value of the Analytics component.

contextual

contextual: boolean

Whether the related query was contextual.

Note: The framework normally sets this field by retrieving the information from the related query.

Optional customData

customData: object

Additional metadata to send along with the event.

Note: This field may include custom user context information (see Sending Custom Context Information).

Example: { "currentResultsPerPage": 25, "userRole": "developer" }

Type declaration

  • [key: string]: any

device

device: string

The name of the device or browser that triggered the event.

Note: The framework normally sets this field by parsing the current navigator.userAgent value.

Example: Chrome

didYouMean

didYouMean: boolean

Whether the did you mean feature was enabled for the related query.

Note: The framework normally sets this field by retrieving the information from the related query.

Example: @source=="Product Documentation"

Optional facetState

facetState: IAnalyticsFacetState[]

A representation of the state of each dynamic facet in the search interface when the action that triggered the event was executed.

language

language: string

The language of the search interface from which the event originates.

Must be a valid ISO-639-1 code.

Note: By default, the framework sets this field according to the currently loaded culture file (see Changing the Language of Your Search Interface).

Example: en

mobile

mobile: boolean

Whether the event originates from a mobile device.

Note: The framework normally sets this field by parsing the current navigator.userAgent value.

numberOfResults

numberOfResults: number

The number of query result items returned by the related query.

Note: The framework normally sets this field by retrieving the information from the related Search API query response.

originContext

originContext: string

The broad application context from which the event originates.

Note: By default, the framework sets this field to Search. However, you can use the setOriginContext method of the Analytics component to modify the default value.

Example: Search

originLevel1

originLevel1: string

The identifier of the search interface from which the event originates.

Note: This field is normally set through the searchHub option of the Analytics component. However, when actually recording the event, the Coveo Cloud usage analytics service may override this value with information extracted from the search token.

Example: PartnerPortalSearch

originLevel2

originLevel2: string

The identifier of the tab from which the event originates.

Note: The framework normally sets this field to the identifier of the currently selected Tab in the search interface.

Example: All

Optional originLevel3

originLevel3: string

The address of the webpage that linked to the search interface from which the event originates.

Note: The framework normally sets this field to the current document.referrer value.

Example: http://example.com/

pageNumber

pageNumber: number

The 0-based page of results requested for the related query.

Note: The framework normally sets this field by retrieving the information from the related query.

queryPipeline

queryPipeline: string

The name of the query pipeline to which the related query was routed.

Note: The framework normally sets this field by retrieving the information from the related Search API query response.

Example: PartnerPortalSearchPipeline

queryText

queryText: string

The original basic query expression (i.e., q) sent for the related query.

Note: The framework normally sets this field by retrieving the information from the related query.

Example: coveo machine learning

responseTime

responseTime: number

The time it took to get a response from the Search API for the query related to the event (in milliseconds).

Note: The framework normally sets this field to 0, except for search events in which case it sets the field by retrieving the information from the related Search API query response.

resultsPerPage

resultsPerPage: number

The number of results per page requested for the related query.

Note: The framework normally sets this field by retrieving the information from the related query.

searchQueryUid

searchQueryUid: string

The unique identifier of the related query.

Note: The framework normally sets this field by retrieving the information from the related Search API query response.

Example: 74682726-0e20-46eb-85ac-f37259346f57

splitTestRunName

splitTestRunName: string

The name of the A/B test that applied to the related query.

Note: This field may be set through the splitTestRunName option of the Analytics component. However, if the option is left undefined, the framework attempts to set this field by retrieving information from the related Search API query response.

Example: Test new ART model

splitTestRunVersion

splitTestRunVersion: string

The version of the A/B test that applied to the related query (i.e., version A or version B).

Note: This field may be set through the splitTestRunVersion option of the Analytics component. However, if the option is left undefined and the related Search API query response indicates that an A/B test was applied, the framework sets this field to the name of the query pipeline to which the query was routed.

Example: PartnerPortalSearchPipelineWithART

Optional userAgent

userAgent: string

The software acting on behalf of the end-user whose action triggered the event.

Note: By default, the framework sets this field to the current navigator.userAgent value.

Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36

Optional userDisplayName

userDisplayName: string

The display name of the end-user whose action triggered the event.

Note: This field is normally set to the userDisplayName option value of the Analytics component. However, when actually recording the event, the Coveo Cloud usage analytics service may override this value with information extracted from the search token.

Example: Alice Smith

Optional userGroups

userGroups: string

The groups the end-user whose action triggered the event belongs to.

Note: This field is normally left undefined, and the Coveo Cloud usage analytics service attempts to extract the information from the search token when actually recording the event.

Optional username

username: string

The identifier of the end-user whose action triggered the event.

Note: This field is normally set to the user option value of the Analytics component. However, when actually recording the event, the Coveo Cloud usage analytics service may override this value with information extracted from the search token.

Example: asmith@example.com

Hierarchy