Get started

This is for:

Taking advantage of Coveo Usage Analytics (Coveo UA) can be a game changer as it not only lets you measure and therefore maximize your search solution adoption, but it also feeds Coveo Machine Learning (Coveo ML) features with usage analytics data that can significantly improve your user experience.

This article focuses on how to get going on your Coveo UA journey.

To get started with Coveo UA

Get familiar with the usage analytics concepts.
Ensure that you’re a member of a group with the required privileges to access and make changes in the Coveo Administration Console Analytics pages (see Manage privileges).
Ensure that the Coveo front-end products you use push standard search-related events and metadata.
- Coveo for Salesforce
  
  By default, Coveo for Salesforce search components automatically push standard search-related usage analytics events and dimensions to your Coveo organization. You have nothing to do.
- Coveo for Sitecore 5
  
  The Coveo UA module is enabled by default in a Coveo-powered Search Page. Therefore, no configuration is needed to capture search page events.
- Coveo Atomic library
  
  When used correctly, Atomic components take care of logging standard search-related usage analytics events for you. No additional configuration required.
- Coveo Headless library
  
  When used correctly, Headless controllers take care of logging standard search-related usage analytics events for you. No additional configuration required.
- Coveo JavaScript Search Framework standalone search interfaces
  
  A standalone Coveo JavaScript Search Framework search interface must simply contain the Analytics component with minimal configuration to automatically push all default search events to Coveo UA for your Coveo organization.
- Coveo hosted search page

An administrator can configure a hosted search page to send standard search-related usage analytics data to a Coveo organization when performing the first time configuration.

View your usage analytics data.

You can view the usage analytics data pushed from your Coveo products in different ways:
- Review default reports and create new ones (see Reports).
- Review individual user visits from the Visit Browser (see Review user visits with the Visit Browser).
- Export and analyze usage analytics data with your preferred tool (see Manage raw data).
Leverage your usage analytics data.
- Take advantage of usage analytics data to maximize your search solution adoption.
- Take advantage of Coveo ML features that feed on Coveo UA.

Consider adding custom metadata.

After working with default events and dimensions, you may want to also gather information specific to your environment. A developer can do that by adding code to push custom metadata to your search-related events or even custom events with custom metadata.

Custom data can only be leveraged when using the UA Protocol. If you’re using the Event Protocol, keep in mind that custom fields have been replaced by predefined events and dimensions. To learn more about the available protocols, see Track usage analytics.

Push custom events and metadata (developer task).
- In Coveo for Salesforce, see Send context information in Salesforce Lightning
- In Coveo for Sitecore, see Adding custom usage analytics metadata
- In a Coveo Atomic search page, see Usage analytics
- In a Coveo Headless search page, see Usage analytics
- In a Coveo JavaScript Search Framework search page, see Send your own search, click, or custom events
Create matching custom dimensions (administrator task).

In the Coveo Administration Console, you must create a custom dimension for each custom metadata to make them available in the Visit Browser as well as in dashboards and explorers.