Review and manage explorers

This is for:

Business Analyst System Administrator

Once you’ve created a usage analytics explorer, you can review and manage it to better understand your organization’s search usage data. The various explorers templates as well as the blank explorers contain two report cards: the Metric Time Series card and the Table card.

Explorer report cards | Coveo

1 Metric Time Series card: Shows the evolution of the selected metrics over time.

2 Table card: Shows the selected dimensions and metrics in a table format.

Depending on the explorer template you selected, the cards will contain different metrics and dimensions. You can add alternate metrics and dimensions to the cards to better evaluate your search solution. If you added a blank explorer, you’ll need to add the desired metrics and dimensions to the cards.

Notes

  • The data that you can review may be limited by the permissions filters set up by an administrator.

  • The following message appears on the page when Coveo UA isn’t activated for your Coveo organization:

    This section is not available for your organization.

    Contact Coveo Support to activate Coveo UA for your Coveo organization.

View or edit an explorer

To better understand your search usage data, you can view or edit an explorer:

  1. On the Reports (platform-ca | platform-eu | platform-au) page, click the explorer that you want to open, and then click Open in the Action bar.

  2. Click Edit in the upper-right corner.

    Important

    In explorers, the Time series card at the top and the Table card at the bottom are independent entities, meaning that changes in either card don’t affect the other.

Manage graphical and numerical metrics

On a given explorer, you can add or remove graphical and numerical metrics to better analyze search usage data.

Review the graphical and numerical metrics

The graphical and numerical metrics available depends on the explorer template you selected. The following table shows the metrics available in the Activity, Content Gaps, and Search Relevance explorer templates.

Metric Activity explorer Content Gaps explorer Search Relevance explorer

Average Click Rank

x

x

check

Click Event Count

check

x

x

Click Rank

check

x

x

Relevance Index (Legacy)

x

x

check

Search Event Clickthrough (%)

x

x

check

Search Event Count

check

check

x

Search Events with Clicks

x

x

check

Unique Visits

check

check

check

Add graphical and numerical metrics

You can add different metrics to the cards to better analyze search usage data.

  1. In Edit mode, click Edit | Coveo Usage Analytics next to one of the report cards.

  2. Select one or more metrics to be shown in the time series and in the metrics box:

    • Click the links (Search, Click, and Custom) to browse metrics by event type, and then select the one(s) of your choice.

      Add metrics to explorer | Coveo
      Note

      Custom data can only be leveraged when using the UA Protocol. If your Coveo implementation uses the Event Protocol, custom dimensions and metrics shouldn’t be added to a report since they won’t function as expected.

  3. Under Metrics, drag each metric to the place of your choice.

  4. In the Advanced settings section:

    1. Under Filters, add the appropriate filters as needed.

    2. Under options, when you want to see metric trends over the selected period, select Display trend data.

    3. When you want to see metric values on top of every time series points, select the Display metric data option.

    4. Under Data Display, select the time series to be shown using Line or Bar charts.

    5. Under Create a relation using, select Last search or Visit if you’re reporting on a custom event and on a search or click event at the same time, or on an all event category metric or dimension (for example, Unique User IP and Browser).

      Notes

      • Last search links each custom event to the user query immediately preceding (if any) and Visit links each custom event to all queries performed during the user visit in which the custom event happened.

      • The Create a relation using parameter has no effect when you report only on search and click events.

  5. Click Save.

  6. (If you’ve modified the Metric Time Series card) Back on the explorer, click anywhere on the Metric Time Series card, and then hover the cursor over the graph to select one of the following interval values: Hour, Day, Week, or Month.

    Tip
    Leading practice

    A mix of this feature with the date interval selection offers more possibilities.

    For example, you want to investigate hour by hour what happened during an activity drop that occurred on October 30, 2023.

    1. In the upper-right corner, click the box containing the actual date range to access the Report Period dialog, and then select October 30, 2023 (see Set the date interval).

    2. Click Edit | Coveo Usage Analytics.

    3. Select the Hour interval.

    4. Click Apply.

    For each hour, you can see the hourly total value of each metric you selected to be shown in the time series. This way you can pinpoint when the drop started.
Note

(If you selected the Display trend data option) When available and selected to be displayed, the trend indicator (up or down arrow) shows the percentage of increase or decrease for a metric in comparison with the same selected period that preceded (week, month, year…​).

  • An increase is good and a decrease is bad for the following metrics: Click Event Count, Attach to Case Count, Search Event Clickthrough, Search Events With Clicks, and Relevance Index.

  • A decrease is good and an increase is bad for the Average Click Rank metric.

Remove graphical and numerical metrics

You can remove metrics from the cards as needed.

  1. In Edit mode, click Edit | Coveo Usage Analytics next to an explorer card.

  2. Under Metrics, click X next to the metric(s) you want to remove.

  3. Click Save.

Set the date interval

On the explorer, you can set the date interval over which you want to review search usage data. In Edit mode, you can do the following:

  • In the upper-right corner, you can go from the actual date interval selected (last week, month…​) to the previous period or next period by clicking Previous | Coveo Usage Analytics and Next | Coveo Usage Analytics respectively.

  • You can click the date picker to access the Report Period dialog, and then select the date range you want to review (see Set the period to review search usage data).

    Note

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

    For example, you’re reviewing data per Month and want to see how statistics are trending for the first two weeks of the current month, so you click Next | Coveo Usage Analytics.

  • You can compare specific data from a prior period to determine trends in explorers.

    Important

    If you want trends to be shown on the explorer, you must select the Display trend data option.

    1. On the explorer, in Edit mode, click the date picker in the upper-right corner.

    2. In the Report Period panel that appears, in the Compare to section, click the Previous Period, Previous Month, Previous Year, or Custom Period link to set the period to compare the current selected search usage data with.

      The trends in report cards are automatically updated based on your selection.

      By default, the Previous Period is used to compare.

    3. Click Save in the upper-right corner.

Note

By modifying the date range in Edit mode and then saving your changes, the explorer remembers your date range selection so you don’t have to set it each time you open the report.

However, if you aren’t in Edit mode and you modify the date range, your changes will be lost once you leave the explorer.

Manage filters to refine data

Filters allow you to further refine the data you’re analyzing in explorers. On the explorer, in Edit mode, do one of the following:

  • Click filter-add-2 to add global dimension or named filters.

    The selected filter(s) appear in the top bar.

    Filter example | Coveo Usage Analytics

  • Click Edit | Coveo Usage Analytics next to one of the report cards.

    1. In the card that opens, in the Advanced Settings section, under Filters, click filter-add-2 to add global dimension or named filters.

    2. Click Save.

  • To remove a filter, click X next to the filter label directly on the explorer or in a report card.

  • To edit a filter, click the filter label to edit as needed, and then click Save.

Once you’re satisfied with your changes, click Save in the upper-right corner of the explorer.

Manage dimensions in an explorer

On the explorer, you can add or hide dimensions, exclude or include dimension values, or drill down on certain dimension values for further analysis.

  • To hide a dimension: on the Metric Time Series card, hover over the dimension you want to hide, and then click Hide | Coveo Usage Analytics.

  • Hover over a dimension value in the Table card, and then click Exclude | Coveo Usage Analytics to exclude or check to narrow the dimension.

  • (Only on User Query and Keyword dimension values) Hover over a dimension value in the Table card, and then click Search results | Coveo Usage Analytics to view the search results related to the dimension value on the Content Browser (platform-ca | platform-eu | platform-au) page.

    The search results related to the selected dimension value aren’t completely identical to every user since no one has the same permissions.

Add dimensions or metrics to the Table card

You can choose which dimensions and metrics will be displayed in the Table card of the explorer to further analyze search usage data.

  1. On the explorer, in Edit mode, click Edit | Coveo Usage Analytics next to the Table card.

  2. In the Dimensions and Metrics lists, do one of the following to select one or more dimensions and/or metrics to be shown in the table:

    • Click the links (Search, Click, and Custom) to browse dimensions and metrics by event type, and then select the one(s) of your choice.

      Note

      Custom data can only be leveraged when using the UA Protocol. If your Coveo implementation uses the Event Protocol, custom dimensions and metrics shouldn’t be added to a report since they won’t function as expected.

      • Click All, and then use the Filter box to find and select the dimension(s) and metric(s) of your choice.

        Example

        Country and Search Event Count

  3. In the Advanced Settings section:

    1. (Optional) Click filter-add-2, and then create one or more metric filters (see Add dimension and metric filters in cards).

      Important

      Metric filters are only applied to the Table card. Therefore, numerical metric counts (Click Event Count, Search Event Count, etc.) next to the line graph in the Metric Time Series card won’t be affected by the filters.

      For example, you only want to know the user IDs that have 100 clicks or less, so you add the following filter: Click Event Count is lower than or equal to 100. Therefore, the click event count in the Metric time series card (250.1K) won’t be the same as the sum of the click event counts in the Table card.

      Metrics box unaffected | Coveo Usage Analytics

    2. Under Options, select the Row count column checkbox if you want to display the row count in the table.

    3. Under Sort Direction, decide the metric value sort order, by selecting Ascending or Descending.

    4. Set the number of rows per page in the table.

    5. In the Value Destination Link box, set destination links when clicking table values.

  4. Click Save.

    The table is updated to add a column for the selected dimension or metric.

    Example

    If you first select the Country dimension, the table displays metric values for United States, Canada, etc. You narrow down on the data by adding the Device dimension to get all Country and Device combinations such as United States using Firefox, United States using Chrome, Canada using Chrome, etc. If you then remove Country, the table only shows the metric values for the various devices.

See which items were opened following a user query

On the explorer, click Open the Search Relevance (Items) page with a filter on this query | Coveo Usage Analytics next to a Keyword or User Query dimension value.

Note

The Search Relevance explorer opens in a new browser tab with a filter on the query or keyword value (for example, User Query is [User_Query_Value] when clicking Open the Search Relevance page | Coveo Usage Analytics next to a User Query dimension value), showing the items that were opened following a particular query (see Keyword and User query).

Report on custom events

On the explorer, you can report on queries related to custom events.

  1. In Edit mode, click Edit | Coveo Usage Analytics next to the table header.

  2. Search and select User Query and one or more custom dimensions or metrics related to custom events to display (for example, Event Type, Unique Event Value, Custom Event Count…​).

  3. Under Create a relation using, select Last search to link each event to the search event immediately preceding (if any) or select Visit to link each event to all queries performed during the user visit in which the event happened.

    Note

    We recommend that you select Last search when the last query performed by the user is the reason why they did the custom event.

    For example, in Salesforce, when agents attached a result to a case (caseAttach), the last query they made gave them the results they used to do the custom event.

    On the other hand, we recommend that you select Visit in situations where all the queries performed by the user during the visit didn’t resolved their matter.

    For example, when one of your clients creates a case (caseCreate), they, more often than not, tried to get the information they needed by querying on the subject of their matter before doing the custom event. You can then use these queries to create knowledge base article(s) and therefore fill the content gap.

  4. Click Save.

  5. Create a filter on a dimension value (see Add global dimension filters to refine date).

    Example

    Custom Event Value is caseCreate.

Export the content of an explorer

On the explorer, at the lower-right corner of each data table in explorers, click Download as CSV | Coveo Usage Analytics to export the table content as a CSV file.

Download as CSV | Coveo Usage Analytics

Export data based on your current filters

  1. On the explorer, click More | Coveo Usage Analytics in the upper-right corner, and then select Export raw data using current filters.

    Note

    This function exports all the data of your Coveo organization (not only the dimensions and metrics appearing on the page) that meets the criteria (date interval and other filters). When you only want to download the content of the Table card, use the other export feature (see Export the content of an explorer and Data exports).

  2. On the Data Exports (platform-ca | platform-eu | Data platform-au) page, download the newly created export (ZIP file) to your local drive.

Manage access to the explorer

To manage who can access the explorer:

  1. Click More | Coveo Usage Analytics in the upper-right corner, and then select Manage report access.

  2. In the Manage Report Access panel, define who has access to the explorer. For more information, see Manage access to reports.

Notes

  • You can also manage the users access to all private explorers.

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

Apply a template to an explorer

  1. On the explorer, click More | Coveo Usage Analytics in the upper-right corner, and then select Apply template.

  2. In the Select a Template panel that appears, select the template of your choice, and then click Select Template.

  3. Click Save in the upper-right corner.

Note

This option is useful if you’ve deleted one of the three pre-configured explorers in the Reports (platform-ca | platform-eu | platform-au) page, or if you began with a blank explorer and want to use a template instead.

Rename an explorer

  1. On the explorer, in Edit mode, change the explorer name by clicking and editing the original name in the upper-left corner.

    Example

    You want to analyze the workflow of anonymous and authenticated users so you changed the Audience Copy page name to Users Workflow.

  2. Optionally, enter an explorer description.

  3. Click Save in the upper-right corner.

Remove an explorer

To remove an explorer from your list of reports:

  1. On the explorer, click More | Coveo Usage Analytics in the upper-right corner, and then select Delete.

  2. In the Delete Report dialog that appears, click Delete to confirm.

Note

If you inadvertently delete one of the pre-configured explorers, you can recreate them by applying the related template to an explorer.

Share an explorer

You may want to share an explorer with other members of your Coveo organization.

  1. On the explorer, click Edit

  2. In your browser address bar, copy the URL and share the link to any colleagues who have the required privileges to review explorers.

Notes

  • If the explorer you want to share is already saved, you can make appear the shareable link in your browser address bar by selecting the same date interval (for example, last week).

  • The shared link contains all the current report state (filters, dimensions, metrics).

Required privileges

The following table indicates the required privileges to view and edit explorers from the Reports (platform-ca | platform-eu | platform-au) page and associated panels (see Manage privileges and Privilege reference).

Note

Access to explorers or part of their content may be further restricted as a function of the member (see Manage access to reports and Manage permission filters).
Action Service - Domain Required access level

View explorers

Analytics - Analytics data

Analytics - Dimensions

Analytics - Named filters

Analytics - Permission filters

Analytics - Reports

Organization - Organization

View

Edit explorers

Analytics - Analytics data

Analytics - Dimensions

Analytics - Named filters

Analytics - Permission filters

Organization - Organization

View

Analytics - Data exports

Analytics - Reports

Edit

Analytics - Administrate

Allowed