The type of operation that triggered this event. Example: 'firstSearch', 'searchEnter'

The @syscollection of the document that was clicked

The position of the document (one-based) that was clicked in the list of resultsThis number must take into consideration pagination settings. If the pages contain ten results each, the third document of the second page is at the position 22.

The @sysurihash of the document that was clicked

The language that end user is using. Use ISO 639-1 codes. See ISO 639-1 for more information

The origin this event took place

The origin this event took place

The searchQueryUid of the search that returned the document that was clicked. This must be a valid searchQueryUid that contains the provided documentUri and documentUriHash.

The @syssource of the document that was clicked

Indicates if the user is anonymous.

Custom data that can contain all the user defined dimensions and their values. Keys can only contain alphanumeric or underscore characters. Spaces in the key are converted to underscores. Uppercase characters in the key are converted to lowercase characters. It is highly recommended that you create your custom dimension before adding customData

The name of the device that the end user is using

The title of the document that was clicked.

The @sysuri of the document that was clicked

The URL of the document that was clicked.

Whether the end user's device is a mobile device or not

The origin this event took place

The query pipeline of the search that returned the document that was clicked.

The ranking modifier that affected the clicked document.

The name of the A/B test run, if one is active.

The version of the A/B test run, if one is active.

The user agent string of the end user's browser. See User Agent for more information.

The display name of the user performing the search event.

The type of this event

The type of operation that triggered this event

The language that end user is using. Use ISO 639-1 codes. See ISO 639-1 for more information

The origin this event took place

The origin this event took place

Indicates if the user is anonymous.

Custom data that can contain all the user defined dimensions and their values. Keys can only contain alphanumeric or underscore characters. Spaces in the key are converted to underscores. Uppercase characters in the key are converted to lowercase characters. It is highly recommended that you create your custom dimension before adding customData

The name of the device that the end user is using

The searchQueryUid of the last search event that occurred before this event

Whether the end user's device is a mobile device or not

The origin this event took place

The name of the A/B test run, if one is active.

The version of the A/B test run, if one is active.

The user agent string of the end user's browser. See User Agent for more information.

The display name of the user performing the search event.

The type of operation that triggered this event. Example: 'firstSearch', 'searchEnter'

Indicates if the query is modified by contextual filters (for instance, a query to find similar documents)

The language that end user is using. Use ISO 639-1 codes. See ISO 639-1 for more information

The origin this event took place

The origin this event took place

The text that was searched

The time, in milliseconds, between the moment the query was sent and the moment the results were received. Must be greater than zero

The results of this search event

The unique identifier of the search event. Must be a UUID

The advanced part of the query that was sent to the index. Usually this contains various query elements that were not manually added by the user.

Indicates if the user is anonymous.

Custom data that can contain all the user defined dimensions and their values. Keys can only contain alphanumeric or underscore characters. Spaces in the key are converted to underscores. Uppercase characters in the key are converted to lowercase characters. It is highly recommended that you create your custom dimension before adding customData

The name of the device that the end user is using

Whether the end user's device is a mobile device or not

The number of results found. Must be equal to or greater than zero

The origin this event took place

The query pipeline of the search event.

The name of the A/B test run, if one is active.

The version of the A/B test run, if one is active.

The user agent string of the end user's browser. See User Agent for more information.

The display name of the user performing the search event.

The groups that the end user performing the event is a member of

The type of operation that triggered this event (see analyticsActionCauseList

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.

(Required, except when logging View events). The language of the end-user. Must be a valid ISO 639-1 code

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.

The @source of the item that was clicked

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

A value that uniquely identifies the user who is logging the event. Must be a valid UUID.

The @syscollection of the item that was clicked

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

The author of the item that was clicked

The category of the clicked item

The title of the item that was clicked

The @uri of the item that was clicked

The @urihash of the item that was clicked. Deprecated, please use customData.contentIdValue instead.

The URL of the item that was clicked

The origin of the event. Used to specify the deployment from which the user performs the action. Suggested values are Search, InternalSearch, CommunitySearch, or the originLevel1 value

The name/identifier of the search interface from which the event originates. If unspecified and the request is authenticated with a search token, the service attempts to extract the searchHub value from the access token that authenticated the request

The name/identifier of the tab from which the event originates

The URL of the page that redirected the browser to the search interface from which the event originates, i.e. document.referrer

An indication of how good the outcome of this event is. A value of -5 corresponds to the worst possible outcome, a value of 0 corresponds to a neutral outcome, and a value of 5 corresponds to the best possible outcome

The name of the query pipeline which processed the query that led to the click event. When unspecified, the service uses the pipeline value set in the search token, if any

The ranking modifier that affected the clicked item

The name of the A/B test run, if one is active. See Managing A/B Tests

The version of the A/B test run, if one is active

A value to identify which web property an event is related to. This can only contain lowercase letters, numbers, and underscores (_).

Information about the browser and operating system of the end-user who caused the search interface to log an event. See User Agent for more information

The display name of the user performing the event. Can only be specified when authenticated with a token with impersonate privilege. If unspecified and the request is authenticated with a search token, the service attempts to extract the userdisplayName value from the access token that authenticated the request

The custom event type

The custom event value

(Required, except when logging View events). The language of the end-user. Must be a valid ISO 639-1 code

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

A value that uniquely identifies the user who is logging the event. Must be a valid UUID.

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

The unique identifier (typically, the searchUid) of the query that caused the search interface to log the custom event, if applicable

The origin of the event. Used to specify the deployment from which the user performs the action. Suggested values are Search, InternalSearch, CommunitySearch, or the originLevel1 value

The name/identifier of the search interface from which the event originates. If unspecified and the request is authenticated with a search token, the service attempts to extract the searchHub value from the access token that authenticated the request

The name/identifier of the tab from which the event originates

The URL of the page that redirected the browser to the search interface from which the event originates, i.e. document.referrer

An indication of how good the outcome of this event is. A value of -5 corresponds to the worst possible outcome, a value of 0 corresponds to a neutral outcome, and a value of 5 corresponds to the best possible outcome

The name of the A/B test run, if one is active. See Managing A/B Tests

The version of the A/B test run, if one is active

A value to identify which web property an event is related to. This can only contain lowercase letters, numbers, and underscores (_).

Information about the browser and operating system of the end-user who caused the search interface to log an event. See User Agent for more information

The display name of the user performing the event. Can only be specified when authenticated with a token with impersonate privilege. If unspecified and the request is authenticated with a search token, the service attempts to extract the userdisplayName value from the access token that authenticated the request

The type of operation that triggered this event (see analyticsActionCauseList)

(Required, except when logging View events). The language of the end-user. Must be a valid ISO 639-1 code

The original basic query expression (q) in the corresponding search request

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

The unique identifier of the event which led the search interface to log the search event. 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.

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

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

A value that uniquely identifies the user who is logging the event. Must be a valid UUID.

Indicates if the query is modified by contextual filters (for instance, a query to find similar items)

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

The facet state information in JSON ARRAY format at the time the search operation was performed

The index name the search query performed against

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

The origin of the event. Used to specify the deployment from which the user performs the action. Suggested values are Search, InternalSearch, CommunitySearch, or the originLevel1 value

The name/identifier of the search interface from which the event originates. If unspecified and the request is authenticated with a search token, the service attempts to extract the searchHub value from the access token that authenticated the request

The name/identifier of the tab from which the event originates

The URL of the page that redirected the browser to the search interface from which the event originates, i.e. document.referrer

An indication of how good the outcome of this event is. A value of -5 corresponds to the worst possible outcome, a value of 0 corresponds to a neutral outcome, and a value of 5 corresponds to the best possible outcome

The name of the query pipeline which processed the query that caused the search interface to log a search event. When unspecified, the service uses the pipeline value set in the search token, if any

The results of this search event

The name of the A/B test run, if one is active. See Managing A/B Tests

The version of the A/B test run, if one is active

A value to identify which web property an event is related to. This can only contain lowercase letters, numbers, and underscores (_).

Information about the browser and operating system of the end-user who caused the search interface to log an event. See User Agent for more information

The display name of the user performing the event. Can only be specified when authenticated with a token with impersonate privilege. If unspecified and the request is authenticated with a search token, the service attempts to extract the userdisplayName value from the access token that authenticated the request

The groups that the end-user performing the event is a member of. If the request is authenticated with a search token, the service also attempts to extract the userGroups value from the access token that authenticated the log search event request, and logs those groups as well.

(Required, except when logging View events). The language of the end-user. Must be a valid ISO 639-1 code

The URL of the viewed page or component, usually document.location.href

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

A value that uniquely identifies the user who is logging the event. Must be a valid UUID.

The name of a field in the index that identifies the item uniquely. A good practice is to use @permanentid

The value of the field selected as contentIdKey. Generally the @permanentid value in the index

The type of content in the page

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

The origin of the event. Used to specify the deployment from which the user performs the action. Suggested values are Search, InternalSearch, CommunitySearch, or the originLevel1 value

The name/identifier of the search interface from which the event originates. If unspecified and the request is authenticated with a search token, the service attempts to extract the searchHub value from the access token that authenticated the request

The name/identifier of the tab from which the event originates

The URL of the page that redirected the browser to the search interface from which the event originates, i.e. document.referrer

An indication of how good the outcome of this event is. A value of -5 corresponds to the worst possible outcome, a value of 0 corresponds to a neutral outcome, and a value of 5 corresponds to the best possible outcome

This parameter is exposed for backward compatibility reasons. Use originLevel3 instead

The name of the A/B test run, if one is active. See Managing A/B Tests

The version of the A/B test run, if one is active

The title of the item

A value to identify which web property an event is related to. This can only contain lowercase letters, numbers, and underscores (_).

Information about the browser and operating system of the end-user who caused the search interface to log an event. See User Agent for more information

The display name of the user performing the event. Can only be specified when authenticated with a token with impersonate privilege. If unspecified and the request is authenticated with a search token, the service attempts to extract the userdisplayName value from the access token that authenticated the request