Usage Analytics

This is for:

Developer
In this article

Administrators can leverage recorded usage analytics data to evaluate how users interact with a search interface, identify content gaps, and improve relevancy by generating and examining dashboards and reports within the Coveo Administration Console (see Coveo Usage Analytics overview). Moreover, Coveo Machine Learning (Coveo ML) features require UA data to function.

Since version 2.80.0, Coveo Headless supports two tracking protocols: the Coveo UA Protocol and the new Event Protocol (EP).

Event Protocol is a new standard for sending analytics events to Coveo.

It simplifies event tracking by reducing the number of events you need to send to Coveo. For instance, you no longer need to send any search events as they’re logged server-side when you make a request to the Search API.

The protocol also streamlines the event payload, requiring fewer fields. Such streamlining results in a more efficient and less error-prone event tracking process, yielding better machine learning models and usage analytics reports.

Coveo UA vs. EP

In the upcoming Headless V3 release, the Event Protocol will be the default tracking protocol, as it already is with the Commerce engine. In the meantime, you can already use EP with Headless by setting the Engine analyticsMode property to next in the engine configuration, such as in the following example.

const headlessEngine = buildSearchEngine({
  configuration: {
    analytics: {analyticsMode: 'next', trackingId: 'sports'},
    // ...
  },
});

Conversely, to stick with Coveo UA, set the analytics.analyticsMode property to legacy.

const headlessEngine = buildSearchEngine({
  configuration: {
    analytics: {analyticsMode: 'legacy'},
    // ...
  },
});

To determine whether you should migrate to EP, see Migrate to Event Protocol.