---
title: Standard actions and Usage Analytics reference
slug: '1389'
canonical_url: https://docs.coveo.com/en/1389/
collection: build-a-search-ui
source_format: adoc
---
# Standard actions and Usage Analytics reference
This article lists some frequent actions that you may want to make available in a custom [search interface](https://docs.coveo.com/en/2741/) implementation.

The following information is included for each action:

* The category of the [Coveo Analytics event](https://docs.coveo.com/en/260/) (search, click, or custom) that [must be logged](https://docs.coveo.com/en/1373/) when this action is performed.

* The corresponding `actionCause` (for search and click events) or `eventType` and `eventValue` (for custom events).

* The corresponding `[customData](https://docs.coveo.com/en/1341/)` keys, if any.

The actions in this article are grouped into five broad categories:

* [Generic actions](#generic-actions), such as initializing a [search interface](https://docs.coveo.com/en/2741/) or selecting a [tab](https://docs.coveo.com/en/1406/)

* [Search box actions](#search-box-actions), such as submitting user [queries](https://docs.coveo.com/en/231/) or handling [Coveo Machine Learning (Coveo ML)](https://docs.coveo.com/en/188/) [Query Suggestions (QS)](https://docs.coveo.com/en/1015/)

* [Result list actions](#result-list-actions), such as opening or paging [query](https://docs.coveo.com/en/231/) results

* [Facet actions](#facet-actions), such as toggling [facet](https://docs.coveo.com/en/198/) values (either directly or indirectly) or performing [facet](https://docs.coveo.com/en/198/) search

* [Custom filter actions](#custom-filter-actions), such as creating, updating, or interacting with custom or advanced [search result filters](https://docs.coveo.com/en/2740/)

This article only lists common [search interface](https://docs.coveo.com/en/2741/) actions that, when performed, require logging specific [Coveo Analytics events](https://docs.coveo.com/en/260/).
Other frequent actions that don't have this requirement, such as rendering [query](https://docs.coveo.com/en/231/) results or [facets](https://docs.coveo.com/en/198/), aren't included.

> **Important**
>
> You must ensure that user interactions with your custom [search interface](https://docs.coveo.com/en/2741/) implementation log [events](https://docs.coveo.com/en/260/) in a way that resembles what the [Coveo JavaScript Search Framework](https://docs.coveo.com/en/187/) or the [Atomic](https://docs.coveo.com/en/lcdf0264/) or [Headless](https://docs.coveo.com/en/lcdf0493/) libraries would do in similar circumstances.
> Otherwise:
> 
> * Standard [Coveo Analytics reports](https://docs.coveo.com/en/266/) may become incoherent in the underlying [Coveo organization](https://docs.coveo.com/en/185/), especially if that [organization](https://docs.coveo.com/en/185/) powers [Coveo JavaScript Search Framework](https://docs.coveo.com/en/187/), [Atomic](https://docs.coveo.com/en/lcdf0264/), or [Headless](https://docs.coveo.com/en/lcdf0493/) [search interfaces](https://docs.coveo.com/en/2741/) as well as custom [search interfaces](https://docs.coveo.com/en/2741/).
> 
> * [Coveo ML](https://docs.coveo.com/en/188/) models may not function properly, or may require extensive customization.

## Generic actions

This section lists the generic actions that you may want to make available in a custom [search interface](https://docs.coveo.com/en/2741/) implementation.

### Initialize a search interface

The following table lists the actions to use when initializing a [search interface](https://docs.coveo.com/en/2741/).

[%header,cols="4"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`actionCause`
|`customData`

|Load a standard [search interface](https://docs.coveo.com/en/2741/)
|Search
|`interfaceLoad`
|N/A

|Load a recommendation interface
|Search
|`recommendationInterfaceLoad`
|N/A
|===

### Select a tab

The following table lists the actions to use when selecting a [tab](https://docs.coveo.com/en/1406/).
See [Implement tabs](https://docs.coveo.com/en/1382/).

[%header,cols="4"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`actionCause`
|`customData`

|Select a [tab](https://docs.coveo.com/en/1406/)
|Search
|`interfaceChange`
|`interfaceChangeTo`
|===

### Handle Coveo query pipeline triggers

The following table lists the actions to use when handling Coveo [query pipeline triggers](https://docs.coveo.com/en/2792/).

[%header,cols="5"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`eventType`
|`eventValue`
|`customData`

|Run an `execute` [query pipeline trigger](https://docs.coveo.com/en/2792/)
|Custom
|`queryPipelineTriggers`
|`execute`
|`executed`

|Run a `notify` [query pipeline trigger](https://docs.coveo.com/en/2792/)
|Custom
|`queryPipelineTriggers`
|`notify`
|`notification`

|Run a `query` [query pipeline trigger](https://docs.coveo.com/en/2792/)
|Custom
|`queryPipelineTriggers`
|`query`
|`query`

|Run a `redirect` [query pipeline trigger](https://docs.coveo.com/en/2792/)
|Custom
|`queryPipelineTriggers`
|`redirect`
|`redirectedTo`
|===

### Manage user settings

The following table lists the actions to use when managing user settings.

[%header,cols="6"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`actionCause`
|`eventType`
|`eventValue`
|`customData`

|Update user preferences
|Custom
|N/A
|`preferences`
|`preferencesChange`
|`preferenceName`, `preferenceType`

|Resolve user geolocation
|Search
|`positionSet`
|N/A
|N/A
|N/A
|===

### Handle query errors

The following table lists the actions to use when handling [query](https://docs.coveo.com/en/231/) errors.

[%header,cols="5"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`eventType`
|`eventValue`
|`customData`

|Go back to the previous state after a [query](https://docs.coveo.com/en/231/) returned no results
|Custom
|`noResults`
|`noResultsBack`
|N/A

|Log a [query](https://docs.coveo.com/en/231/) error
|Custom
|`errors`
|`query`
|`aq`, `cq`, `dq`, `errorMessage`, `errorType`, `query`

|Go back to the previous state after a [query](https://docs.coveo.com/en/231/) returned an error
|Custom
|`errors`
|`errorBack`
|N/A

|Reset the search box after a [query](https://docs.coveo.com/en/231/) returned an error
|Custom
|`errors`
|`errorClearQuery`
|N/A

|Execute the same [query](https://docs.coveo.com/en/231/) again after a [query](https://docs.coveo.com/en/231/) returned an error
|Custom
|`errors`
|`errorRetry`
|N/A
|===

## Search box actions

This section lists the search box actions that you may want to make available in a custom [search interface](https://docs.coveo.com/en/2741/) implementation.
See [Implement a search box](https://docs.coveo.com/en/1377/).

### Submit user queries

The following table lists the actions to use when submitting user [queries](https://docs.coveo.com/en/231/).
See [Implement a search box - Submit a query](https://docs.coveo.com/en/1377#submit-a-query).

[%header,cols="4"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`actionCause`
|`customData`

|Send a user [query](https://docs.coveo.com/en/231/) from a non-standalone search box
|Search
|`searchboxSubmit`
|N/A

|Execute a user [query](https://docs.coveo.com/en/231/) sent from a standalone search box
|Search
|`searchFromLink`
|N/A

|Clear a non-standalone search box (and send a blank user [query](https://docs.coveo.com/en/231/) as a side effect)
|Search
|`searchboxClear`
|N/A
|===

### Handle Coveo ML query suggestions

The following table lists the actions to use when handling [Coveo ML](https://docs.coveo.com/en/188/) [query suggestions](https://docs.coveo.com/en/1015/).
See [Implement a search box - Provide Coveo Machine Learning query suggestions](https://docs.coveo.com/en/1377#provide-coveo-machine-learning-query-suggestions).

[%header,cols="4"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`actionCause`
|`customData`

|Select a [Coveo ML](https://docs.coveo.com/en/188/) [query suggestion](https://docs.coveo.com/en/1015/) from a non-standalone search box
|Search
|`omniboxAnalytics`
|`partialQueries`, `partialQuery`, `suggestionRanking`, `suggestions`

|Execute a [Coveo ML](https://docs.coveo.com/en/188/)-suggested [query](https://docs.coveo.com/en/231/) selected from a standalone search box
|Search
|`omniboxFromLink`
|`partialQueries`, `partialQuery`, `suggestionRanking`, `suggestions`

|Trigger a search-as-you-type [query](https://docs.coveo.com/en/231/)
|Search
|`searchAsYouType`
|`partialQueries`, `partialQuery`, `suggestionRanking`, `suggestions`
|===

### Handle field-based query suggestions

The following table lists the actions to use when handling [field](https://docs.coveo.com/en/200/)-based [query suggestions](https://docs.coveo.com/en/1015/).
See [Implement a search box - Provide field-based query completion suggestions](https://docs.coveo.com/en/1377#provide-field-based-query-completion-suggestions).

[%header,cols="4"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`actionCause`
|`customData`

|Select a [field](https://docs.coveo.com/en/200/)-based suggestion
|Search
|`omniboxField`
|N/A
|===

### Correct queries

The following table lists the actions to use when correcting [queries](https://docs.coveo.com/en/231/).
See [Implement a search box - Correct queries](https://docs.coveo.com/en/1377#correct-queries).

[%header,cols="4"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`actionCause`
|`customData`

|Select a [query](https://docs.coveo.com/en/231/) correction suggestion
|Search
|`didyoumeanClick`
|N/A

|Trigger an automatically corrected [query](https://docs.coveo.com/en/231/)
|Search
|`didyoumeanAutomatic`
|N/A
|===

## Result list actions

This section lists the result list actions that you may want to make available in a custom [search interface](https://docs.coveo.com/en/2741/) implementation.
See [Implement a result list](https://docs.coveo.com/en/1372/).

### Open query results

The following table lists the actions to use when opening [query](https://docs.coveo.com/en/231/) results.
See [Implement a result list - Open query results](https://docs.coveo.com/en/1372#open-query-results).

[%header,cols="4"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`actionCause`
|`customData`

|Open a [query](https://docs.coveo.com/en/231/) result
|Click
|`documentOpen`
|`author`, `contentIdKey`, `contentIdValue`, `documentTitle`, `documentURL`

|Open a [Coveo ML](https://docs.coveo.com/en/188/) [Content Recommendation (CR)](https://docs.coveo.com/en/1016/) result in a recommendation interface
|Click
|`recommendationOpen`
|`author`, `documentTitle`, `documentURL`

|Preview a [query](https://docs.coveo.com/en/231/) result
|Click
|`documentQuickview`
|`author`, `contentIdKey`, `contentIdValue`, `documentTitle`, `documentURL`
|===

### Page query results

The following table lists the actions to use when paging [query](https://docs.coveo.com/en/231/) results.
See [Implement a result list - Page query results](https://docs.coveo.com/en/1372#page-query-results).

[%header,cols="5"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`eventType`
|`eventValue`
|`customData`

|Navigate to a specific page of [query](https://docs.coveo.com/en/231/) results
|Custom
|`getMoreResults`
|`pagerNumber`
|`pagerNumber`

|Navigate to the next page of [query](https://docs.coveo.com/en/231/) results
|Custom
|`getMoreResults`
|`pagerNext`
|`pagerNumber`

|Navigate to the previous page of [query](https://docs.coveo.com/en/231/) results
|Custom
|`getMoreResults`
|`pagerPrevious`
|`pagerNumber`

|Scroll down to get more results in infinite scroll mode
|Custom
|`getMoreResults`
|`pagerScrolling`
|N/A

|Select the number of [query](https://docs.coveo.com/en/231/) results to display per page
|Custom
|`getMoreResults`
|`pagerResize`
|`currentResultsPerPage`
|===

### Sort query results

The following table lists the actions to use when sorting [query](https://docs.coveo.com/en/231/) results.
See [Implement a result list - Sort query results](https://docs.coveo.com/en/1372#sort-query-results).

[%header,cols="4"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`actionCause`
|`customData`

|Select the result list sort criteria or direction
|Search
|`resultsSort`
|`resultsSortBy`
|===

### Switch result list layouts

The following table lists the actions to use when switching result list layouts.
See [Implement a result list - Switch result list layouts](https://docs.coveo.com/en/1372#switch-result-list-layouts).

[%header,cols="5"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`eventType`
|`eventValue`
|`customData`

|Select the result list layout
|Custom
|`resultsLayout`
|`changeResultsLayout`
|`resultsLayoutChangeTo`
|===

### Export query results

The following table lists the actions to use when exporting [query](https://docs.coveo.com/en/231/) results.
See [Implement a result list - Export results](https://docs.coveo.com/en/1372#export-results).

[%header,cols="5"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`eventType`
|`eventValue`
|`customData`

|Export the [query](https://docs.coveo.com/en/231/) results to an Excel document
|Custom
|`misc`
|`exportToExcel`
|N/A
|===

## Facet actions

This section lists the [facet](https://docs.coveo.com/en/198/) actions that you may want to make available in a custom [search interface](https://docs.coveo.com/en/2741/) implementation.
See [Implement facets](https://docs.coveo.com/en/3199/).

### Toggle facet values

The following table lists the actions to use when toggling [facet](https://docs.coveo.com/en/198/) values.
See [Implement facets - Toggle facet values](https://docs.coveo.com/en/3199#toggle-facet-values).

[%header,cols="4"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`actionCause`
|`customData`

|Select a single value in a [facet](https://docs.coveo.com/en/198/)
|Search
|`facetSelect`
|`facetField`, `facetId`, `facetTitle`, `facetValue`

|Un-select a single value in a [facet](https://docs.coveo.com/en/198/)
|Search
|`facetDeselect`
|`facetField`, `facetId`, `facetTitle`, `facetValue`

|Exclude a single value in a [facet](https://docs.coveo.com/en/198/)
|Search
|`facetExclude`
|`facetField`, `facetId`, `facetTitle`, `facetValue`

|Un-exclude a single value in a [facet](https://docs.coveo.com/en/198/)
|Search
|`facetUnexclude`
|`facetField`, `facetId`, `facetTitle`, `facetValue`

|Reset selected and excluded values in a [facet](https://docs.coveo.com/en/198/)
|Search
|`facetClearAll`
|`facetField`, `facetId`, `facetTitle`

|Select a numeric value range in a [facet](https://docs.coveo.com/en/198/)
|Search
|`facetRangeSlider` / `facetRangeGraph`
|`facetField`, `facetId`, `facetRangeStart`, `facetRangeEnd`

|Select or un-select a single [facet](https://docs.coveo.com/en/198/) value by interacting with a [query](https://docs.coveo.com/en/231/) result
|Search
|`documentField`
|`facetField`, `facetId`, `facetTitle`, `facetValue`

|Un-select or un-exclude a single [facet](https://docs.coveo.com/en/198/) value by interacting with [breadcrumbs](https://docs.coveo.com/en/2731/)
|Search
|`breadcrumbFacet`
|`facetId`, `facetTitle`, `facetValue`

|Clear all selected/excluded [facet](https://docs.coveo.com/en/198/) values by interacting with [breadcrumbs](https://docs.coveo.com/en/2731/)
|Search
|`breadcrumbResetAll`
|N/A
|===

### Sort facet values

The following table lists the actions to use when sorting [facet](https://docs.coveo.com/en/198/) values.
See [Implement facets](https://docs.coveo.com/en/3199/).

[%header,cols="5"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`eventType`
|`eventValue`
|`customData`

|Change [facet](https://docs.coveo.com/en/198/) sort criteria or direction
|Custom
|`facet`
|`facetUpdateSort`
|`criteria`, `facetId`, `facetTitle`
|===

### Perform facet search

The following table lists the actions to use when performing [facet](https://docs.coveo.com/en/198/) search.
See [Implement facets - Perform facet search](https://docs.coveo.com/en/3199#perform-facet-search).

[%header,cols="5"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`eventType`
|`eventValue`
|`customData`

|Search for a value in a [facet](https://docs.coveo.com/en/198/)
|Custom
|`facet`
|`facetSearch`
|`facetId`, `facetTitle`
|===

### Switch between conjunctive and disjunctive facet

The following table lists the actions to use when switching between a conjunctive and disjunctive [facet](https://docs.coveo.com/en/198/).

[%header,cols="4"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`actionCause`
|`customData`

|Toggle a [facet](https://docs.coveo.com/en/198/) operator
|Search
|`facetToggle`
|`facetId`, `facetOperatorBefore`, `facetOperatorAfter`
|===

## Custom filter actions

The following table lists the custom filter actions that you may want to make available in a custom [search interface](https://docs.coveo.com/en/2741/) implementation.

[%header,cols="4"]
|===
|Action
|[event](https://docs.coveo.com/en/260/)
|`actionCause`
|`customData`

|Create, update, or interact with a custom [search result filter](https://docs.coveo.com/en/2740/)
|Search
|`customfiltersChange`
|`customFilterName`, `customFilterType`, `customFilterExpression`

|Create or update an advanced [search result filter](https://docs.coveo.com/en/2740/)
|Search
|`advancedSearch`
|N/A

|Clear an advanced [search result filter](https://docs.coveo.com/en/2740/) by interacting with [breadcrumbs](https://docs.coveo.com/en/2731/)
|Search
|`breadcrumbAdvancedSearch`
|N/A
|===