Getting Started With Coveo Usage Analytics

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

This article tells you how to get going on your Coveo usage analytics journey.

To get started with Coveo UA

  1. Get familiar with the Coveo UA concepts (see Usage Analytics Concepts).

  2. Ensure that you are a member of a group with the required privileges to access and make changes in the administration console Analytics pages (see Privilege Management).

  3. Ensure the Coveo front-end products you use push standard search-related events and metadata.

    • Coveo for Salesforce

      Out-of-the-box, Coveo for Salesforce search components automatically push standard search-related usage analytics events and dimensions to your Coveo Cloud organization. You have nothing to do.

    • Coveo for Sitecore 5

      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).

    • 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 out-of-the-box search events to Coveo UA for your Coveo Cloud organization (see Coveo Component Analytics).

    • Coveo hosted search pages

      An administrator can configure a hosted search page to send standard search-related usage analytics data to a Coveo Cloud organization when performing the first time setup (see Manage Search Pages).

  4. Visualize your usage analytics data

    You can visualize the usage analytics data pushed from your Coveo products in different ways:

  5. Leverage your usage analytics data

  6. Consider adding custom metadata

    After working with out-of-the-box 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.

    1. Push custom events and metadata (developer)

    2. Create matching custom dimensions (administrator)

      In the 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 (see Adding and Managing Dimensions on Custom Metadata).