THIS IS ARCHIVED DOCUMENTATION

Coveo Usage Analytics

This is for:

Developer System Administrator

Pro and Enterprise only

The Coveo Usage Analytics (Coveo UA) module allows you to track analytics data for a Coveo-Powered Search Page. Various events that occur within it (queries, clicks, etc.) are logged in the Coveo Platform, where they can be used to generate custom reports.

The Coveo UA module is enabled by default in a Coveo-Powered Search Page. Therefore, no configuration is needed to capture search page events (see Usage analytics events).

Accessing usage analytics reports

You need to log in to your Coveo 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. The second screenshot shows the Summary report.

  • Visit Browser, for a detailed description of all events for each visit. The example below shows John Doe’s visit and its related events.

To gain deeper knowledge and understanding of Coveo UA, see Coveo Usage Analytics overview.

Understanding usage analytics events

A usage analytics event is any user interaction with a search page, including queries, clicks, page views, and CustomEvents (see Usage Analytics Events).

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.

Recording a search event relies on two elements: Cause and Dimensions.

  • A Cause has a name and a type. It’s itself a Dimension.

    An example of a cause would be interfaceLoad or facetSelect.

  • A Dimension is a grouping of metadata key-value pairs principally exploited within the dashboards, reports, and explorers within the Coveo UA pages.

    For examples of Dimensions, see Usage analytics dimensions.

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 view events (see Logging view events).