Skip to end of metadata
Go to start of metadata

The Coveo Usage Analytics module allows you to track analytics data for a Coveo Search Page. The various events that occur within it (queries, clicks, etc.) are logged in the Coveo Cloud Platform, where they can be used to generate custom reports. Since the Coveo Usage Analytics module is enabled by default in a Coveo Search Page, you do not need to configure anything to capture search page events.

Accessing Usage Analytics Reports

You need to login to your Coveo Cloud organization to view your Usage Analytics reports. 

In the Analytics section of the main menu, select:

  • Reports: For an overview of all your analytics, in graph and chart form.
  • Visit Browser: For a detailed description of all events for each visit.

For more information on how to navigate and understand Coveo Cloud Usage Analytics, see Coveo Cloud Usage Analytics. 

Understanding Usage Analytics Events

A usage analytics event is any user interaction with a search page, including Queries, Clicks, Page Views, and Custom Events (see Usage Analytics Recorded Events).

The act of recording a search event relies on two elements: the Cause and the Dimensions.

  • Cause has a name and a type. It is itself a Dimension.
    An example of a cause would be interfaceLoad or facetSelect
  • Dimension is a grouping of metadata key-value pairs principally exploited within the dashboards, reports, and explorers within the Coveo Cloud Usage Analytics pages.
    For examples of Dimensions, see Usage Analytics Dimensions.

The Analytics module only tracks events triggered within the web context. To track events triggered from another context, change the database property for the coveoanalytics site by creating a patch element in the Coveo.SearchProvider.Custom.config file.

What's Next

You can now learn how to configure custom metadata for your analytics (see Adding Custom Usage Analytics Metadata in Coveo for Sitecore) and how to enable logging of page view events (see Logging Page View Events).


  • No labels