Reviewing and Managing Dashboards

You can use the Reports page in the Analytics section of the administration console navigation menu to review the data collected by Coveo Usage Analytics (Coveo UA).

Starting from an empty page, you can add sections, graphs, tables, filters, metrics, and dimensions, and then save the result as a custom dashboard (see Usage Analytics Dimensions and Usage Analytics Metrics). Custom dashboards can be modified or removed at any time.

The usage analytics data that you can review can be limited by your permissions (see Adding and Managing Permission Filters).

Access a Dashboard

  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.

  3. On the Reports page:

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

      OR

    • Double-click the desired dashboard.

  4. When needed, enter the Edit mode:

    On the [Dashboard name] page, in the top right corner of the screen, click Edit.

    Changes you made prior accessing the Edit mode are kept. You must thus remove these changes (if unwanted) before saving the dashboard.

Rename a Dashboard

  1. On the [Dashboard name] page, in the Edit mode, in the top left corner of the dashboard page, change the dashboard name by clicking and editing the original name.

  2. (Optional) Enter a dashboard description by clicking and editing the original description.

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

Set a Predefined Date Interval Over Which You Want to Review Search Usage Data

On the [Dashboard name] page, in the Edit mode, in any time series card, click and drag the mouse over an area.

Admin-SelectDatesInLineChart

  • All the data shown in the report will match the selected period.

  • This feature is particularly useful when you notice a period where there was an unexpected change for one or more metrics.

OR

On the [Dashboard name] page, in the Edit mode, in the top right corner of the window, you can quickly go from the actual date interval selected (last week, month…) to the previous period or next period by clicking the left (Icon-LeftArrowb) and right (Icon-RightArrowb) arrow icons respectively.

You can select a period that is incomplete (e.g., the current month), in which case your date range selection will always include the latest available events until the period ends (e.g., the first day of the following month).

You are reviewing data per Month and want to see how statistics are trending for the first two weeks of the current month, so you click the right arrow icon (Icon-RightArrowb).

Alternatively, you can click the box containing the actual date range (e.g., Icon-ActualDateRangeb - by default the last 7 complete days) to access the Report Period dialog, and then select the date range you want to review (see Setting the Period to Review Search Usage Data).

Add One or More Global Dimension Filters to Refine Search Usage Analytics Data

On the [Dashboard name] page, in the Edit mode, access the dialog to add global dimension filters by clicking the filter addition icon (Icon-FilterAdditionc) (see Adding Global Dimension Filters.

Manage Global Dimension Filters

Add a Named Filter With Current Dimension Filters

  1. On the [Dashboard name] page, in the top right corner of the screen, click Edit.

  2. At the right-end of the top bar, click the action icon (Icon-FilterActionb), and then select Save filters as.

  3. In the Save as a Named Filter dialog, in the first input, enter a meaningful Filter name, and then click Save.

    The named filter is now applied to the report.

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

Edit a Global Filter Configuration

  1. On the [Dashboard name] page, in the top right corner of the screen, click Edit.

  2. Click the global filter label.

  3. Make your changes.

  4. Click Save.

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

Enable and Disable Global Filters

  1. On the [Dashboard name] page, in the top right corner of the screen, click Edit.

  2. Next to the global filter label, click the action icon (Icon-FilterAction), and then select Enable or Disable.

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

Reverse the Global Filter Operator

  1. On the [Dashboard name] page, in the top right corner of the screen, click Edit.

  2. Next to the global filter label, click the action icon (Icon-FilterAction), and then select Reverse operator.

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

Remove a Global Filter

  1. On the [Dashboard name] page, in the top right corner of the screen, click Edit.

  2. Next to the global filter label, click the action icon (Icon-FilterAction), and then select Remove.

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

Remove All Global Filters

  1. On the [Dashboard name] page, in the top right corner of the screen, click Edit.

  2. At the right-end of the top bar, click the action icon (Icon-FilterActionb), and then select Delete all filters.

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

Manage Dashboards

Export and Import a Complete Dashboard Configuration

  1. On the [Dashboard name] page, in the top right corner of the screen, click the More icon (Icon-Dropdownd), and then select Copy to clipboard.

    • The Copy to clipboard option is ONLY available outside the Edit mode.

    • This feature is useful when you want to export your dashboard configurations from your staging environment to production without having to recreate all your dashboards manually.

    • The configuration is exported in JSON format.

  2. Copy the dashboard configuration.

    Depending on your browser compatibility with the copy/cut feature of the execCommand method (see Browser compatibility):

    • When your browser supports the feature, the configuration is automatically copied in your clipboard.

    • When your browser does not support the feature, in the Export a Report Configuration dialog that appears, copy the configuration.

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

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

  5. In the dashboard that appears:

    1. In the Edit mode, in the top right corner of the screen, click the More icon (Icon-Dropdownd), and then select Paste JSON configuration.

    2. In the Import a Report Configuration dialog that appears, click Import and Save.

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

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

Edit a Dashboard Configuration

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

  1. On the [Dashboard name] page, in the top right corner of the screen, click the More icon (Icon-Dropdownd), and then select Edit JSON configuration.

  2. In the Edit a Report JSON Configuration: [Report_Name] 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 Apply.

  3. (When you copy a dashboard part) In the navigation bar on the left, under Analytics, select Reports.

  4. On the Reports page, access or create a dashboard:

    • Double-click an existing dashboard.

      OR

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

      OR

    • Click Add, and then select Blank dashboard.

  5. In the dashboard:

    1. On the [Dashboard name] page, in the top right corner of the screen, click the More icon (Icon-Dropdownd), and then select Edit JSON configuration.

    2. In the Import 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 Import and Save.

Export and Import a Part of a Dashboard

This feature is useful when you want to export and import only a section or a card of a dashboard, and not the complete configuration.

  1. On the [Dashboard name] page, in the Edit mode, in the top right corner of the screen, click the More icon (Icon-Dropdownd), and then select Edit JSON configuration.

  2. In the Edit a Report JSON Configuration: [Report_Name] dialog that appears:

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

    2. Click Save.

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

  4. On the Reports page, access an existing dashboard by double-clicking an existing dashboard, or clicking a dashboard, and then in the Action bar, clicking Open.

  5. In the dashboard:

    1. On the [Dashboard name] page, in the Edit mode, in the top right corner of the screen, click the More icon (Icon-Dropdownd), and then select Edit JSON configuration.

    2. In the Edit a Report JSON Configuration: [Report_Name] 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.

Manage the Access to the Dashboard

  • You can also manage the members access to all private dashboards (see Manage Report Access).

  • By default, dashboards are accessible to all group members with the View right on Reports.

  1. Access a dashboard.

  2. On the [Dashboard name] page, in the Edit mode, access the Manage Report Access dialog (in the top right corner of the screen, click the More icon (Icon-Dropdownd), and then select Manage report access), and then define who has access to the dashboard (see Managing Usage Analytics Report Access in Reports.

Apply a Template to a Dashboard

  1. On the [Dashboard name] page, in the Edit mode, in the top right corner of the screen, click the More icon (Icon-Dropdownd), and then select Apply template.

  2. In the Select a Template panel:

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

    2. Click Select Template.

    3. If you selected Case Creation Page Metrics, in the Add Case Creation Page Metrics Report panel that appears:

      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 is 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 is logged when a user cancels their case creation or select None when your page does not contain a cancel button.

      4. Click Add Report.

        A report named Case Creation Page Metrics appears.

    4. If you selected General Search Interface Metrics, in the Add General Search Interface Metrics Report panel that appears:

      1. Under Select search interface, click the drop-down menu, and then select the search interface you want to analyze.

      2. Click Add Report.

        A report named General Search Interface Metrics appears.

    5. If you selected Detailed Summary, in the Add Detailed Summary Report panel that appears:

      1. Under Select search interface (Origin level 1), click the drop-down menu, and then select the search interface you want to analyze.

      2. Click Add Report.

        A report named Detailed Summary appears.

    6. If you selected Support Agents, in the Add Support Agents Report panel that appears:

      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 do not 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 Sending Your Own Search, Click, or Custom Events and Add Dimension on Custom Metadata). Otherwise, some metric cards on the report will not load.

      3. Click Add Report.

        A report named Support Agents appears.

    7. If you selected A/B Testing, in the Add an A/B Test Report panel that appears:

      Your Coveo Cloud 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 Cloud organization, not only the A/B tests created in the Coveo Cloud administration console (see Adding and Managing A/B Tests).

      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.

      3. Click Add Test.

        A report named A/B Testing: [Selected_Test_Name] appears.

Remove a Dashboard

  1. On the [Dashboard name] page, in the Edit mode, in the top right corner of the screen, click the More icon (Icon-Dropdownd), and then select Delete.

  2. In the Delete Report confirmation prompt that appears, click Delete.

Add a Section

Dashboards contain an empty section template that only appears in Edit mode.

  1. On the [Dashboard name] page, in the Edit mode, you simply have to click Add card to section to officially create the section.

  2. At the top left corner, in the input, enter a meaningful section title.

    User Adoption

Sections without cards are deleted after saving the dashboard.

You can also duplicate an existing section with the Duplicate button and then only modify what needs to be different (see Duplicating an Analytics Dashboard Element).

Add a Card

On the [Dashboard name] page, in the Edit mode, in a section, click Add card to section, and then select one of the following usage analytics card types:

Manage Sections and Cards

  • On the [Dashboard name] page, in the Edit mode:

    • Edit a Section or a Card Title

      1. Click the section or card title.

      2. Edit the title.

        In Edit mode, all auto-generated card titles (which occurs if the title box is empty before saving the dashboard) are shown as Enter a card title.

      3. Click outside the title box to validate the change.

    • Resize a Section or a Card

      1. Hover over a section or a card and the resize icon (Icon-Resize) appears at the bottom right of the section or the card.

      2. Click and hold the resize icon (Icon-Resize) , and then move the mouse to resize the card or graph at the desired width and height.

      3. When you are done, release the left mouse button.

    • Replace a Section or a Card

      1. Click and hold the move icon (icon-Replaceb) at the top left corner of card or the drag icon (Icon-Dragb) at the top left corner of a section, and then move the mouse to replace the section or the card at the desired position.

        You can move cards from a dashboard section to another and you can place dashboard sections side-by-side.

      2. When you are done, release the left mouse button.

    • Move a Card or a Section From a Tab to Another

      1. Click and hold the move icon (icon-Replaceb) at the top left corner of a card or the drag icon (Icon-Dragb) at the top left corner of a section, and then hover the label of the desired tab or the Add Tab label.

      2. When you are done, release the left mouse button.

        When you release the mouse button over the Add Tab, a new tab is created with the moved card or section.

    • Edit a Card (Graph, Table, Metric)

      At the top right corner of the card, click the Edit icon (Icon-Pencil3b).

    • Duplicate a Card or a Section

      At the top right corner of the card or section, click the Duplicate icon (Icon-DuplicateElementb).

    • Remove a Section

      At the top right corner of the card, click the Delete icon (Icon-GarbageBlue).

    • Remove a Card (Graph, Table, Metric)

      At the top right corner of the card, click the Delete icon (Icon-GarbageBlue).

  • On the [Dashboard name] page:

    • Explore the Data Behind Each Card

      At the top right corner of a card, click the Explore Data icon (Icon-ExploreDatab) (see Reviewing Content Behind Dashboard Cards).

      This feature is ONLY available outside the Edit mode.

Manage Tabs

  • Dividing dashboards into tabs can simplify a dashboard configuration and improve its loading time.

  • Each tab acts as a dashboard section, meaning that:

    • The global filters and the report period applied on the dashboard impact all tabs;

    • You can take advantage of the same features such as managing cards.

  • You simply have to click the tab label to review the tab content.

On the [Dashboard name] page, in the Edit mode:

Add a Tab

Under the filter toolbar, next to Tab [n], click Add Tab.

The first time you proceed, a tab named Tab 2 appears next to Tab 1.

Instead of creating a dashboard per user, you can create one dashboard in which you assign a tab per user.

Rename a Tab

Click the tab label, and then edit the original name.

Re-order Tabs

Drag and drop the tab label by clicking the drag icon (icon-Replaceb) next to the tab label and dragging the tab label to the location of your choice.

For a tab to be the first starting from the left, you have to move the desired tab in second place, and then move the first tab in second place.

Duplicate a Tab

Next to a tab label, click the Duplicate icon (Icon-DuplicateElementb).

Remove a Tab

Next to a tab label, click the Delete icon (Icon-GarbageBlue).

Move Content From a Dashboard to Another

  1. On the [Dashboard name] page, in the Edit mode, depending on the report container you want to move:

    To copy a card, section, or tab from a dashboard to another, you simply have to duplicate the report element, and then proceed with the following procedure (see Duplicating an Analytics Dashboard Element).

    • For a tab or a card

      At the top left corner of a card or next to the tab label, click and hold the move icon (icon-Replaceb).

    • For a section

      At the top left corner, click and hold the drag icon (Icon-Dragb).

  2. Move the mouse to the middle right of the report where the Move icon (Icon-Move) appears, and then release the left mouse button.

  3. In the Select the Location to Move the Content dialog, select the dashboard Name check box in which you want to move the content.

    • By default, the content is moved to the first tab of the selected dashboard.

    • When your organization has a large number of reports, use the Filter box to find a dashboard more easily.

    • You can only move content to dashboards you have access to (see Manage the Access to the Dashboard).

  4. Click Move.

  5. In the Content Moved dialog, click Save and Go to save the current report and reach the new content location or click Stay on this Report.

Change the Time Series Card Interval

On the [Dashboard name] page, in the Edit mode, in the top right corner of a time series card, select one of the following intervals to set how data is grouped in the graph: Hour, Day, Week, and Month.

When you review the search usage data of last week and you select Day, each point in the graph represents a day.

Required Privileges

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

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 dashboard

Analytics - Analytics data

Analytics - Dimensions

Analytics - Named filters

Analytics - Permission filters

Analytics - Reports

Organization - Organization

View
Edit dashboard

Analytics - Analytics data

Analytics - Dimensions

Analytics - Named filters

Analytics - Permission filters

Organization - Organization

View

Analytics - Exports

Analytics - Reports

Edit
Analytics - Administrate Allowed

What’s Next?

See what you can do with dashboards (see Use Case: Creating a Dashboard Linking to the Visit Browser).