Add Usage Analytics Dashboards

As a member of the Administrators or the Analytics Managers built-in groups, you can use the Analytics section of the Administration Console navigation menu to create custom usage analytics dashboards. You can create and use custom dashboards to focus only on trends and anomalies that you want to address or don’t find by default in the Summary dashboard (see Review the Search Usage Trends From the Summary Dashboard).

Add a Usage Analytics Dashboard

  1. Log in to the Coveo Platform as a member of a group with the required privileges to manage reports in the target Coveo organization.

  2. In the navigation bar on the left, under Analytics, select Reports.

  3. On the Reports page:

    1. Click Add, and then select Dashboard from template or Blank dashboard.

      OR

      Click the dashboard you want to copy, and then in the Action bar, click Duplicate.

    2. If you select Dashboard from template, in the Select a Template panel:

      1. Select the radio button of one of the available templates:

      2. Click Select Template.

      3. For templates that require configuration, select or provide the required information, and then click Add Report or Add Test (for the A/B Testing template).

        Depending on the selected template, see their related options:

  4. In the upper-left corner of the report:

    1. In the first input, enter a title for the dashboard.

    2. (Optional) In the second input, enter a description for the dashboard.

  5. Click Save in the upper-right corner.

    The report is now available on the Reports page.

    By default, members of the Administrators and Analytics Managers groups of your organization have access to all dashboards. However, dashboards can be shared to only specific members or saved for your own personal use (see Manage the Access to the Dashboard).

“General Search Interface Metrics” Template Option

In the Add General Search Interface Metrics Report panel, under Select search interface, click the drop-down menu, and then select the search interface you want to analyze.

“Case Creation Page Metrics” Template Options

In the Add Case Creation Page Metrics Report panel:

  1. Under Select a case creation page, click the drop-down menu, and then select the page you want to analyze.

  2. Under Select Submit case custom event, click the drop-down menu, and then select the name of the custom event that’s logged when a user creates a case.

  3. Under Select Cancel case custom event, click the drop-down menu, and then select the name of the custom event that’s logged when a user cancels their case creation or select None when your page doesn’t contain a cancel button.

“Detailed Summary” Template Option

In the Add Detailed Summary Report panel, under Select search interface (Origin level 1), click the drop-down menu, and then select the search interface you want to analyze.

“Support Agents” Template Options

In the Add Support Agents Report panel:

  1. In the first input, enter the Total number of agents in your organization.

  2. In the Custom dimension name (unique case identifier) input, enter the name of the dimension that uniquely identifies your support cases.

    When you don’t already have a dimension that covers this use case, ask a developer to set up the dimension, and then add it in the Administration Console (see Send Your Own Search, Click, or Custom Events and Add Dimension on Custom Metadata). Otherwise, some metric cards on the report won’t load.

“A/B Testing” Template Options

In the Add an A/B Test Report panel:

Your Coveo organization must contain at least two query pipelines associated with an active A/B Test, and usage analytics data must be available for at least one of the two pipelines. Otherwise, you will get the Missing Required Usage Analytics Data error message when adding the report.

  1. Under Select test, click the drop-down menu, and then select one of the available test sets.

    The drop-down menu lists all test sets available for your Coveo organization, not only the A/B tests created in the Coveo Administration Console.

  2. In the Item A and Item B drop-down menu, select the two items (not necessarily pipelines) in the selected test set that you want to compare.

Required Privileges

The following table indicates the required privileges to view and edit dashboards from the Reports page and associated panels (see Manage Privileges and Privilege Reference).

Access to dashboards or part of their content may be further restricted as a function of the member (see Manage Access to Usage Analytics Reports and Manage Permission Filters).

Action Service - Domain Required access level
View dashboards

Analytics - Analytics data

Analytics - Reports

View
Edit dashboards

Analytics - Analytics data

View

Analytics - Reports

Edit
Analytics - Administrate Allowed

What’s Next?

Recommended Articles