Usage Analytics Events

A usage analytics event is recorded and sent to Coveo Usage Analytics (Coveo UA) when an end-user, authenticated or not, performs an action on a Coveo-powered user interface.

In Coveo UA, an action is defined as a search, a click, a custom, or a view event. These actions must be recorded from a search interface (see Event Categories).

The search interface sends event metadata to Coveo UA. Event metadata must be associated with UA dimensions to be leveraged in the Administration Console Visit Browser and usage analytics reports (see Understanding Usage Analytics Dimensions). Raw events are also consumed by Coveo Machine Learning (Coveo ML) to build models which improve and personalize the search experience (see Leverage Machine Learning).

An end-user accesses a Coveo-powered search interface, types hdmi issue in the search box, and then presses Enter.

The search interface then gathers relevant metadata and sends it in the form of a search event (searchboxSubmit) to the UA database, making it viewable in your Coveo organization.

The recorded event metadata and dimensions appear in the Visit Browser as one element under the user visit. The same event is also included in reports with a matching scope.

VisitBrowser

Event Categories

Coveo interfaces built with the Coveo JavaScript Search Framework automatically send search, click, and custom events to your Coveo organization. The metadata of those standard UA events is associated with dimensions and is available to be used in reports. You can further add custom metadata to your events and associate them to dimensions to better tailor the collected information to your context (see Manage Dimensions on Custom Metadata and Send Custom Metadata with Search, Click, or Custom Events). Additionally, you may want to log view events to leverage Coveo ML Event Recommendations (see Send Usage Analytics Page View Events).

The following table indicates some typical UA events sent following a given end-user action.

Event category Occurrence
Search

When an end-user interacts with a search interface in a way that triggers the Search API, a search event is logged.

End user action examples:

  • An end-user enters keywords in a search box and sends a query by clicking the search button.
  • An end-user clicks the next search results page.
  • An end-user views recommended results without searching.
  • An end-user refines search results by selecting facets.
Click

When an end-user clicks or previews search results, a click event is logged.

End user action examples:

  • An end-user clicks an item to see it.
  • An end-user clicks the Quick View button to quickly visualize what the page refers to.
  • An end-user clicks an item in the recommendation interface.
View

When an end-user accesses a tracked page, a view event is logged.

End user action example:

  • An end-user accesses a recommended page from the recommendation interface.

Custom

When an end-user performs an action that needs to be recorded, but that's neither a search, a click, or a view event, a custom event is recorded.

End user action examples:

  • An end-user selects the number of query results to display per page.
  • An end-user clicks a custom navigation button.
Recommended Articles