Usage Analytics Events

A usage analytics event is a set of parameters describing a single action performed by an end user on a Coveo-powered search interface. This action is defined as a search, a click, a view, or a custom event. The Coveo-powered search interface is typically a search page or a case creation panel built with the Coveo JavaScript Search Framework.

Coveo-powered search interfaces automatically send search, click, and custom events to Coveo Usage Analytics (Coveo UA) where they’re subsequently stored and processed. The metadata of these events is associated with UA dimensions and is leveraged in the Administration Console Visit Browser and in UA reports.

EXAMPLE

An end user types hdmi issue in the search box of a Coveo-powered search interface and 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.

VisitBrowser

The same event is also included in reports with a matching scope.

Events are also leveraged by Coveo Machine Learning (Coveo ML) to build models which improve and personalize the search experience. You can further add custom metadata to your events and associate them to dimensions to better tailor the collected information to your context. You may also want to log view events to leverage Coveo ML Event Recommendations.

Event Categories

Search (PerformSearch)

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

Search events are used to calculate metrics such as Search Event Count and can be separated into three categories: manual search event, which is done consciously by the user on a particular topic, automatic search event, which is triggered automatically without the user noticing, and manual search event refinement.

For a complete list of actions that trigger search events, see search event causes.

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 (DocumentView)

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

The click events are used to calculate metrics such as Average Click Rank and Click Event Count.

For a complete list of actions that trigger click events, see click event causes.

EXAMPLES
  • An end user clicks an item to see it.

  • An end user clicks the Quick View button to quickly visualize what the page contains.

  • An end user clicks an item in the recommendation interface.

View

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

The view events provide data to Coveo Machine Learning (Coveo ML) for the Event Recommendations (ER) module (see About Event Recommendations).

EXAMPLE

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

Custom (CustomEvent)

When an end user performs an action that is recorded, but it’s neither a search, a click, or a view event, a custom event is logged.

Other events are those that neither generate a search event nor access a search result item.

For a complete list of actions that trigger custom events, see custom event types.

EXAMPLES
  • An end user selects the number of query results to display per page.

  • An end user clicks a custom navigation button.

Recommended Articles