Interface IClickEvent

Describes a Coveo Cloud usage analytics click 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

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.

clientId

clientId: string

A GUID representing the current user. This GUID is generated locally and stored in a non-expiring browser cookie.

collectionName

collectionName: string

The name of the collection to which the clicked query result item belongs.

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

Example: default

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

documentCategory

documentCategory: string

The type of query result item that was clicked.

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

Example: FAQ

documentPosition

documentPosition: number

The 1-based position of the clicked item in the query results set.

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

documentTitle

documentTitle: string

The title of the clicked query result item.

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

Example: Coveo ML Frequently Asked Questions

documentUri

documentUri: string

The URI of the clicked query result item.

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

Example: http://www.example.com/org:organization/articletype:FAQ/article:aB1c2000000A1BcDEF/language:en_US

documentUriHash

documentUriHash: string

The hashed URI of the clicked query result item.

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

Example: AbCñdeFghiJKLM1n

documentUrl

documentUrl: string

The URL of the clicked query result item.

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

Example: https://example.com/aB1c2000000A1Bc

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.

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/

queryPipeline

queryPipeline: string

The name of the query pipeline to which the Search API query that returned the clicked result item was routed.

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

Example: PartnerPortalSearchPipeline

rankingModifier

rankingModifier: string

The ranking modifier that was applied to the clicked query result item.

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

Example: Reveal ART

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.

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

sourceName

sourceName: string

The name of the source that contains the clicked query result item.

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

Example: Product Documentation

splitTestRunName

splitTestRunName: string

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

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

Example: Testing new ART model

splitTestRunVersion

splitTestRunVersion: string

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

Note: This field is normally set by the splitTestRunVersion option of the Analytics component. However, if this 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`

viewMethod

viewMethod: string

The way the item was clicked.

Note: The framework normally sets this field to the exact same value as actionCause.

Example: documentOpen

Hierarchy