Reviewing and Managing Explorers

You can use the Reports page in the Analytics section of the administration console navigation menu to review the data collected by the usage analytics service (see Who Can Perform the Page Actions).

By default, a Coveo Cloud organization comes with three default explorers that can also be used as templates to create other explorers (see Explorer Templates). These pre-configured explorers present search usage metrics in numeric, graphical, and tabular format. The indicator values are presented for a selectable date interval. You can add metrics and dimensions to the table to better evaluate the search solution (see Usage Analytics Dimensions and Usage Analytics Metrics).

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

Access an Explorer

  1. Log in to your Coveo Organization with an Admin, Analytics Viewer or Analytics Manager user role account.

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

  3. In the Reports page, in the Name column, click the explorer you want to review.

    You can access the Activity pre-configured explorer by selecting Activity

    The following message appears in the page when the Usage Analytics service is not activated for your Coveo Cloud organization. Contact Coveo Support to activate the usage analytics service for your Coveo Cloud organization.

    This section is not available for your Organization.

  4. When needed, enter the Edit mode:

    In the [Explorer 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 explorer.

Review the Graphical and Numerical Metrics That are Available by Default

In the [Explorer name] page, review the available metric values (see Access an Explorer):

  • The graphical and numerical metrics available by default depends on the default explorer you reached.

  • Each clickable box updates the timeline graph next to it accordingly. The box contains some metric values such as the total number of clicks, queries, or visits for the selected date interval and filters, the daily Average and Peak (number of clicks or queries for the day with highest number of clicks or queries) click or query values. A trend indicator is also provided as a comparison of the selected time period with the same selected period that preceded.

  • Values in the box (total metric counts) can not match the sum of all metric values in the table at the bottom of the explorer, depending on the selected dimension(s) and metric filters (if any). The table only thus displays metric values for a precise scope of data while the values in the box are count based on all Organization usage analytics data for the selected period (when no global dimension filter in the top bar are applied).

  • Numbers in the boxes are rounded and shortened when bigger than ten thousands (10 000):

    • 10 000 = 10K

    • 10 500 = 10.5K

    • 100 100 = 100.1K

    • 1 049 999 = 1M

  • Click Count

    This clickable box reports click counts.

    This box is only available by default in the Activity pre-configured explorer.

  • Query Count

    This clickable box reports query counts.

  • Query with clicks

    This box is only available by default in the Search Relevance pre-configured explorer and it replaces the Query Count box.

    This clickable box reports counts of query resulting in at least one click.

  • Visit Count

    This clickable box reports the total count of visits, which are the number of visits regardless of unique IP addresses and user names for the selected date interval and filters (see Usage Analytics Metrics).

  • Timeline

    This time series shows the number of clicks, queries, or visits per day by default, depending on the user selection (see Interval).

    The timeline uses your browser’s time zone.

  • Data table

    The table presents the data for the selected date range, filters, dimensions and metrics.

    Relevance metrics (Relevance Index, Average Click Rank, and Click-Through) values are colored to show if they are good, bad, or neutral.

    The predefined thresholds for each metrics are the following:

    • Average Click Rank: 1-3 = good (green), 3-6 = neutral (black), and > 6 = bad (red)

    • Click-Through: < 40% = bad (red), 40-60% = neutral (black), and > 60% = good (green)

    • Relevance Index: < 0.5 = bad (red), 0.5-0.7 = neutral (black), and > 0.7 = good (green)

      Admin-ColoredMetricsValuesb

    The Activity table shows a list for the Query dimension with the Click Count, Query Count, and Visit Count metrics.

    You can sort the table by a dimension or a metric by ascending or descending order by clicking the corresponding column header.

Manage Graphical and Numerical Metrics

In the [Explorer name] page, you can (see Access an Explorer):

  • Add One or More Graphical and Numerical Metrics

    1. In the Edit mode, click the Edit icon (Icon-Pencil3) next to the metrics box.

    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 quickly browse metrics by event type, and then select the one(s) of your choice (see Usage Analytics Metrics).

        OR

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

    3. Under Selected Metrics, review the metrics order in the box by drag-and-dropping the metrics to the place of your choice.

    4. When you report on a custom event and on a search or click event (you added a filter or selected a dimension or metric related) at the same time, or on an all event type metric or dimension (e.g., Unique User IP and Browser), choose to Create a relation using the Last Search or the Visit between the event types.

      • Last Search links each custom event to the 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.

      • Your selection here is automatically replicated in the time series to match metrics total value.

    5. Click More to access advanced settings.

    6. In the More section:

      1. Choose how the data is grouped in the time series by selecting one of the following interval values: Automatic, Hour, Day, Week, or Month. By default, Automatic is selected.

        • When you choose Automatic, the data is grouped in the time series based on the interval value that most fits the selected date range:

          Selected Date Range Interval Value
          181 days and more Month
          60 to 180 days Week
          60 hours to 59 days Day
          1 to 59 hours Hour
          Less than an hour Minute
        • The interval can be modified at any time.

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

        You want to investigate hour by hour what happened during an activity drop that occurred on October 30, 2014.

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

        2. Click the Edit (Icon-Pencil3) icon.

        3. Select the Hour interval.

        4. Click Apply.

        You see, for each hour, the hourly total value of each metric you selected to be shown in the time series. This way you can know exactly the hour the drop started.

      2. When you want to see metric trends over the selected period, select the Display trend data option (see Trends).

      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. Click Apply.

  • Remove One or More Graphical and Numerical Metrics

    1. In the Edit mode, click the Edit icon (Icon-Pencil3) next to the metrics box (see Access an Explorer).

    2. Under Selected Metrics, click the minus icon (-) next to the metric(s) you want to remove from the time series and the metrics box.

    3. Click Apply.

  • Remove a metric from the time series

    Admin-AddMetrics2c

    Deselect the desired metric check box.

  • Add a metric in the time series

    Admin-AddMetrics2a

    Hover over the desired metric box and click the plus sign icon.

  • Review each metric daily value

    Admin-MetricsDayValuec

    Hover over a date.

    The color next to the value matches the metric label color.

  • Determine trends

    Admin-DetermineTrend

    Compare specific data with data from a prior period (see Set a Period Used to Establish the Trends in Numerical Metric Boxes).

    When available and selected to be displayed, the trend indicator shows the percentage of increase or decrease for a metric in comparison with the same selected period that preceded (week, month, year…).

    The trending arrow has a color that reflects if the trend for the selected period is good (green) or bad (red) depending on the metric. The colored arrow is dedicated to metrics for which an increase or decrease is good or bad in all cases:

    Admin-TrendingArrow

    • An increase is good and a decrease is bad for the following metrics: Click Count, Attach to Case Count, Click-Through, Queries With Click, and Relevance Index.

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

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

In the [Explorer name] page, in the Edit mode, at the top section of the explorer, in the time series, click and drag the mouse over an area (see Access an Explorer):

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

In the top right corner of the screen, 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-LeftArrow) and right (Icon-RightArrow) arrow icons respectively or you can click the box containing the actual date range (e.g., Icon-ActualDateRange - 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).

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

If you want trends to be shown in the numerical metric boxes, you must select the Display trend data option (see Trend Option).

  1. In the [Explorer name] page, in the Edit mode, in the top right corner of the screen, click the box containing the actual date range (see Access an Explorer).

  2. In the Report Period dialog 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 the numerical metric boxes are automatically updated based on your selection.

    Admin-NumericalMetrics

    • By default, the Previous Period is used to compare.

    • The explorer remembers your date range selection so you do not have to set it each time the report is displayed.

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

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

  1. In the [Explorer name] page, hover your cursor over the dimension value for which you want to add a filter (see Access an Explorer).

    Admin-MultipleFiltersc

  2. Click the Explore other dimensions icon (Icon-MultipleFilters1) next to the dimension value.

  3. In the window that appears, select one or many dimension values you want to exclude (Icon-Exclude) or to narrow to (Icon-Check).

  4. Click Apply selection.

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

    Admin-FilterEx7

OR

In the [Explorer name] page, in the Edit mode, access the dialog to add global dimension filters by clicking the filter addition icon (Icon-FilterAdditionb) (see Access an Explorer and Adding Global Dimension Filters).

Narrow a Report to a Dimension Value

In the [Explorer name] page, click the Narrow icon (Icon-Check) next to the dimension value (see Access an Explorer).

OR

Select the checkbox next to the dimension value and click include.

Exclude a Dimension Value From a Report

In the [Explorer name] page, click the Exclude icon (Icon-Exclude) next to the dimension value (see Access an Explorer).

OR

Select the checkbox next to the dimension value and click exclude.

In the [Explorer name] page, click the Search Results icon (Icon-SearchIcon1) next to the dimension value (see Access an Explorer).

Admin-ContentBrowser4

You can click Next to see other search results for the dimension value.

  • Your Coveo Cloud organization must have a configured search endpoint (see Managing Your Coveo Cloud V1 Organization Settings).

  • Only the Query and Keyword dimension values have the Search Results icon (Icon-SearchIcon1).

  • The search results related to the selected dimension value are not completely identical to every user since no one has the same permissions.

    Many users performed the query blank bx620 and they do not click on any search results. You want to identify potential content gaps or relevance issues from the related search results list. By clicking the Search Results icon (Icon-SearchIcon1) next to the query, you have to keep in mind that you may not have the same search results as the users that performed the query in the first place.

See Which Documents Were Opened Following a Query

In the [Explorer name] page, click the Open the Search Relevance page icon (Icon-ExplorerExpand) next to a keyword or query dimension value (see Access an Explorer).

The Search Relevance explorer opens in a new browser tab with a filter on the query or keyword value (e.g., Query is [Query_Value] when clicking the Open the Search Relevance page icon (Icon-ExplorerExpand) next to a Query dimension value), showing the items that were opened following a particular query (see Keyword and Query).

Manage Predefined Filters

The page may contain one or more predefined filters that are always applied when you access the page to show more meaningful data.

In the [Explorer name] page, in the Edit mode, click the x icon next to the predefined filter labels to remove those filters (see Access an Explorer).

The Search cause is not interfaceLoad hidden filter is applied to the Keyword page to exclude the queries that are automatically generated to present default search results when users initially access the search interface and did not yet enter keywords in the search box.

Admin-ShowHideHiddenFilter1d

1 Predefined filter (identifiable by its light blue background and its pin icon)
2 Manually entered filter (white background)

Edit Predefined and Custom Filters

In the [Explorer name] page, in the Edit mode (see Access an Explorer):

Admin-EditFiltersc

1 Click the filter label.
2 Edit the filter content.
3 Click Add Filter.

Add Dimensions or Metrics to the Data Table

  1. In the [Explorer name] page, in the Edit mode, click the Edit icon (Icon-Pencil3) next to the table header (see Access an Explorer).

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

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

      OR

    • Click All, and then use the Search dimensions and Search metrics boxes to respectively find and select the dimension(s) and metric(s) of your choice.

    Country and Query Count

  3. Click More to access advanced settings.

  4. In the More section:

    1. (Optional) Click the add filters icon (Icon-AddFiltersc), and then create one or more metric filters (see Adding Dimension and Metric Filters in Usage Analytics Cards).

    2. In the Value Destination Link box, set destination links when clicking table values (see Setting Destination Links On Card Title and Values).

      Metric filters are ONLY applied to the table content. Thus, numerical metric count(s) (Click Count, Query Count, etc.) next to the line graph will not be affected by the filter(s).

      You only want to know the user IDs that have 20 clicks or more, so you add the following filter: Click Count is greater than 20. The click count next to the time series (1186) is not the same as the sum of the click counts in the table (214).

      Admin-MetricsBoxUnaffected

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

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

      In the Rows box, enter the number of rows per page.

      By default, the table has ten rows per page.

  5. Click Apply.

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

If you first select the Country dimension, the table displays metric values for United States, Canada, etc. You further slice and dice the data by adding the Device dimension to get all Country+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.

You can quickly remove dimensions and metrics from a data table by hovering over the dimension or metric name, clicking the icon-X2 icon in the Edit mode, and then saving your modifications.

Report on Queries That Surrounded a Custom Event

  1. In the [Explorer name] page, in the Edit mode, click the Edit icon (Icon-Pencil3) next to table header (see Access an Explorer).

  2. Search and select Query and one or more dimensions or metrics related to custom events to display (i.e., Event Type, Custom Event Value, Custom Event Count…) (see Usage Analytics Dimensions and Usage Analytics Metrics).

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

    Your selection here is automatically replicated in the time series to match metrics total value.

    It is recommended to select Last Search in situations where the last query performed by the user is the reason why he did the custom event.

    In Salesforce, when an agent attached a result to a case (caseAttach), the last query he made gave him the results he used to do the custom event.

    On the other hand, it is recommended to select Visit in situations where all the queries performed by the user during the visit did not resolved his matter.

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

  4. Click Apply.

  5. Create a filter on a dimension value (see Add Filter).

    Custom Event Value is caseCreate.

    When you selected Last Search, in the Query column, you see the query that immediately preceded all the custom event you filter on.

    When you selected Visit, in the Query column, you see all queries performed during the user visit in which the custom event(s) you filter on happened.

Export the Content of a Usage Analytics Explorer

Admin-DownloadAsCSV

In the [Explorer name] page, at the bottom right corner of each data table in explorers (pre-configured or custom), click the Download as CSV icon (Icon-DownloadAsCSV) to export the table content as a CSV file (see Access an Explorer).

When you have more than ten thousands results, this dialog box appears:

Admin-DownloadAsCSV2

Click Download the First 10,000 Rows or click Cancel to add one or more filters (see Add One or More Global Dimension Filters to Refine Search Usage Analytics Data).

Export Usage Analytics Data Based on Your Current Filters

  1. In the [Explorer name] page, in the top right corner of the screen, click the More icon (Icon-Dropdownc), and then select Export raw data using current filters (see Access an Explorer).

    This function exports all the data of your Coveo Cloud organization (not only the dimensions and metrics appearing in the page) that meets the criteria (date interval and other filters). When you only want to download the content of a report table, rather use the other export feature (see Export the Content of a Usage Analytics Explorer).

  2. In the Exports page, in the list of exports, download the newly created export (ZIP file) on your computer (see Download an Export).

Manage the Access to the Explorer

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

  • By default, explorers are accessible to all usage analysts (Analytics Viewers and Analytics Managers).

In the [Explorer name] page, access the Manage Report Access dialog (in the top right corner of the screen, click the More icon (Icon-Dropdownc), and then select Manage Report Access), and then define who has access to the explorer (see Managing Usage Analytics Report Access in Reports and Access an Explorer).

Apply a Template to an Explorer

  1. In the [Explorer name] page, in the top right corner of the screen, click the More icon (Icon-Dropdownc), and then select Apply Template (see Access an Explorer).

  2. In the Apply Template dialog box that appears, select the radio button next to the template of your choice, and then click Apply (see Explorer Templates).

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

This option is very useful when you have deleted one of the three pre-configured explorers.

Rename an Explorer

  1. In the [Explorer name] page, in the Edit mode, in the top left corner of the screen, change the explorer name by clicking and editing the original name (see Access an Explorer).

    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. In the top right corner of the screen, click Save.

Remove an Explorer

In the [Explorer name] page, in the top right corner of the screen, click the More icon (Icon-Dropdownc), and then select Delete (see Access an Explorer).

If you delete one of the pre-configured explorers by inadvertence, you can recreate them by applying the related template to an explorer and saving it (see Apply a Template to an Explorer).

Share an Explorer

In the [Explorer name] page, in the Edit mode, before you save an explorer, in your browser address bar, copy the URL and share the link to any colleagues who have the required roles to review explorers within or outside your Coveo Cloud organization (see Access an Explorer).

  • 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 (e.g., last week).

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

  • When a colleague outside your Coveo Cloud organization open the shared link, he sees his own Coveo Cloud organization data, reorganized with your explorer configuration.

Who Can Perform the Page Actions

The required roles are:

  • Analytics Manager

    OR

  • Analytics Viewer (can only review explorer content)

    OR

  • Administrator