Adding and Managing Usage Analytics Reports

Administrators and analytics managers can use the Coveo Cloud administration console Reports page to manage the usage analytics reports of a Coveo Cloud organization.

Instead of opening each report to perform management actions such as duplicating, deleting, and editing, you can now do these actions directly on the Reports page that lists all reports of your organization.

If you are currently migrating your Coveo Cloud organization from V1 to V2, note that all actions related to report management (e.g., adding a dimension filter in a usage analytics report card, adding a named filter to a report, etc.) in one organization will be effective in the other as well. However, modifications related to features that apply only to Coveo Cloud V2 organizations will not be displayed in the V1 equivalent.

Access the “Reports” Page

  1. If not already done, log in to the Coveo Cloud platform as a member of a group with the required privileges to manage reports in the target Coveo Cloud organization.

  2. In the main menu on the left, under Analytics, select Reports.

Add a Dashboard

  1. On the Reports page header, at the right, click Add, and then select Blank dashboard or Dashboard from template (see Creating Usage Analytics Dashboards).

    If the Add button is grayed and unresponsive, you do not have all required privileges to perform this action.

  2. Fill the empty dashboard that appears with tabs, sections, and cards (see Reviewing and Managing Dashboards).

Open a Report

On the Reports page, in the list of reports:

Click the report that you want to open, and then in the Action bar, click Open.

OR

Double-click the desired report.

Duplicate a Report

On the Reports page, in the list of reports:

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

A report named [Original Report Name] Copy is created and ready to be modified (see Reviewing and Managing Dashboards or Reviewing and Managing Usage Analytics Explorers).

The report is immediately available on the Reports page.

Filter Reports

On the Reports page, in the Action bar, click the report type drop-down menu, and then select one of the following quick filters: All, Dashboard, or Explorer to sort reports by type.

OR

Click the filter box, and then enter a report name or a report type to find the report(s) you are looking for.

The filter automatically applies itself as you type.

Export a Report Configuration

  1. On the Reports page, in the list of reports, click the report of which you want to export the configuration.

  2. In the Action bar, click More, and then select Export Report.

    The configuration is automatically copied in your clipboard.

  3. (When your browser does not support the copy/cut feature of the execCommand method) In the Export a Report Configuration panel that appears, copy the dashboard configuration (see Browser compatibility).

  4. In your actual Coveo Cloud organization or in another one (e.g., your Coveo Cloud organization in production), in the main menu on the left, under Analytics, select Reports.

  5. On the Reports page, click Add, and then select Blank dashboard.

  6. In the dashboard that appears:

    1. In the top right corner of the screen, click the More icon (Icon-Dropdownd), and then select Import configuration.

    2. In the Import a Report Configuration dialog that appears, paste the configuration, and then click Import and save.

      The dashboard looks exactly the same as the one you exported. The only possible difference could be the analytics data if you export a dashboard from another Coveo Cloud organization.

    3. In the top right corner of the screen, click Save.

Edit the Report JSON Configuration

This feature is useful when you are more comfortable editing dashboards in JSON than directly in the dashboards themselves.

  1. On the Reports page, in the list of reports, click the report of which you want to edit the configuration.

  2. In the Action bar, click More, and then select Edit configuration.

  3. In the Edit a Report Configuration dialog that appears:

    1. Make your modifications, and then click Save.

      OR

    2. Locate and select the configuration part that you want to import in another dashboard, and then copy your selection.

    3. Click Save.

  4. (When you copy a dashboard part) In the main menu on the left, under Analytics, select Reports.

  5. On the Reports page, select the dashboard in which you want to import the copied part:

    • Double-click on the dashboard.

      OR

    • Click the dashboard, and then in the Action bar, click Open.

  6. In the dashboard:

    1. In the top right corner of the screen:

      1. Click Edit.

      2. Click the More icon (Icon-Dropdownd), and then select Edit configuration.

    2. In the Edit a Report Configuration dialog that appears, locate the place where you want to put the dashboard part you copied, and then paste the JSON code.

    3. Click Save.

Permanently Remove One or More Reports

  1. On the Reports page, click the report you want to delete, and then in the Action bar, click Delete.

  2. At the Are you sure? prompt, click Delete.

Review Report Management Activities

The Activity panel list presents the report management activities in the reverse chronological order. Each row represents one activity, indicating when it occurred, the display name of the affected report, what was done (created, updated, deleted), and by who (user).

You can review the creation, change, and deletion history of your reports. To do so, on the Reports page, click the Activity icon (ac8-icon-clock) (see Review Events Related to Specific Coveo Cloud Administration Console Resources).

If the Activity icon is grayed and unresponsive, you do not have all required privileges to perform this action.

Required Privileges

The following table indicates the required privileges to view and edit dashboards and explorers from the Reports page and associated panel.

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

Action Service - Privilege Required access level
View dashboards and explorers

Analytics - Analytics data

Analytics - Dimensions

Analytics - Named filters

Analytics - Permission filters

Analytics - Reports

Organization - Organization

View
Edit dashboards and explorers

Analytics - Analytics data

Analytics - Dimensions

Analytics - Named filters

Analytics - Permission filters

Organization - Organization

View

Analytics - Data exports

Analytics - Reports

Edit