Coveo Usage Analytics
The Coveo Usage Analytics module allows you to track analytics data for a Coveo Search Page. 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.
The Coveo Usage Analytics module is enabled by default in a Coveo Search Page. Therefore, no configuration is needed to capture search page events (see Usage Analytics Recorded 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. 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 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 CustomEvents (see Usage Analytics Recorded 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 (see Tracking Usage Analytics Events When Production Database is not Named Web).
Recording a search event relies on two elements: Cause and Dimensions.
- A Cause has a name and a type. It is itself a Dimension.
An example of a cause would be
- A 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.
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).