Metrics

This is for:

Business Analyst System Administrator

A metric is a computed numerical value applied as selectable criteria within reports presented in the Coveo Administration Console analytics pages. Metrics are a direct consequence of recorded events that can be visualized as an indicator, a time series, or as values within a usage analytics data report.

The following image is that of a Summary dashboard composed of UA report cards that display metrics:

Metric cards | Coveo Usage Analytics
Note

For some metrics, a high value is good, and for others, a high value can reveal a relevance issue (see Find search implementation successes and issues with metrics).

The available metrics grouped by event category and in alphabetical order are:

Click metrics

Average Click Rank

This metric measures the average position of clicked items in the search results for the specified dimensions and result filters. Its value is greater or equal to 1. Lower values are better. A value of 1 would mean that users always open the first item in the search results list.

Note

Setting goals based on the Average Click Rank metric isn’t recommended for commerce solutions. When shopping online, customers tend to browse through results to see the available products.
Example

The selected dimension is Country and users from Spain have an Average Click Rank value significantly higher than users from other countries. This may indicate poorer content or relevance for content available in Spanish.

image::coveo-platform/2041-average-click-rank.png[Average Click Rank | Coveo Usage Analytics,role="bordered zoom"]

Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Click Event Count

This metric is the total number of clicks for the specified dimensions and filters. In a metric card, in a dashboard without filters, the Click Event Count is the sum of all click events (see Click Event causes).

Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Click Rank Maximum

This metric is the highest position of a clicked item in the search results for the specified dimensions and filters.

Click Rank Minimum

This metric is the lowest position of a clicked item in the search results for the specified dimensions and filters.

Click Rank Sum

This metric is the total of all clicked item positions in the search results for the specified dimensions and filters.

Search Event Clickthrough (%)

This metric is the percentage of search events with at least one click on search results for the specified dimensions and filters. Its value is between 0 and 100. A higher value indicates better search results.

To determine the clickthrough percentage, the Search Events With Clicks and Search Events Counts metrics are used. The formula used to calculate the Search Events Clickthrough % is:

(Search Events With Clicks / Search Events Count) * 100

Note

The clickthrough rate metric is affected by every search event, but not all queries. For instance, when a facet value is selected or deselected, it triggers both a search event and a query to the Search API, hence considered in the calculation. However, navigating between search result pages by clicking a page number triggers a query but not a search event, hence not considered in the calculation.

For example, a search event followed by a click on two facets, and then a click on a result, leads to a clickthrough rate of 33.33% (1/3*100). If you do the same search event but use the page numbers to navigate to the desired result, the clickthrough would be 100% (1/1*100).

Manual Search Event Count

This metric is the total number of queries performed by users (using the search box) for the specified dimensions and filters. In usage analytics, a manual search is defined as a search where the Search Cause dimension contains one of the following values:

  • didyoumeanAutomatic

  • didyoumeanClick

  • searchboxSubmit

  • searchboxAsYouType

  • omniboxSearch

  • omniboxAnalytics

  • omniboxFromLink

  • omniboxField

  • searchFromLink

Notes

  • User query refinements are excluded.

  • The search cause of the related event must be manual for a query to count.
Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Search Events With Clicks

This metric is the total number of queries resulting in at least one click for the specified dimensions and filters.

Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Search Event Count

This metric is the total number of queries for the specified dimensions and filters. In a metric card, in a dashboard without filters, the Search Event Count is the sum of all search events (see Search Event causes).

Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Relevance Index / Relevance Index (Legacy)

This metric is calculated with a formula based on the Search Event Clickthrough and the Average Click Rank metrics to highlight ranking issues. Its value is between 0 and 1. Higher values are better. More frequently submitted queries with clicks on results farther in the search results list yield to a lower value (see Relevance Index metric).

Sorting by this value in descending order brings to the surface the most important potential relevance issues on which an administrator or an analytics manager can focus.

Example

When the Country dimension is selected and Germany has the lowest value for this metric, relevance issue for users from Germany should be investigated.

image::coveo-platform/2041-relevance-index.png[Relevance Index | Coveo Usage Analytics,role="bordered zoom"]

Refined Search Event Count

This metric is the number of query refinements done by users (facets, interface change, etc.) for the specified dimensions and filters.

Note

The search cause of the related event must be manual for a query to count.
Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Unique [Click Dimension Name]

This metric is the number of unique dimension value for the specified dimensions and filters (see Click dimensions).

Example

The Unique Click Cause metric is the number of unique click causes that triggered an event in the search interface to be recorded.

Search metrics

Average Number of Results

This metric measures the average number of results returned by the search interface for the specified dimensions and filters.

Average Response Time (ms)

This metric measures the average time in milliseconds the search interface took to return results for the specified dimensions and filters.

Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Average Search Query Word Count

This metric measures the average number of words in queries for the specified dimensions and filters. It’s calculated based on the total number of words in a query expression, without removing stop words.

Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Search Event Clickthrough (%)

This metric is the percentage of search events with at least one click on search results for the specified dimensions and filters. Its value is between 0 and 100. A higher value indicates better search results.

To determine the clickthrough percentage, the Search Events With Clicks and Search Events Counts metrics are used. The formula used to calculate the Search Events Clickthrough % is:

(Search Events With Clicks / Search Events Count) * 100

Note

The clickthrough rate metric is affected by every search event, but not all queries. For instance, when a facet value is selected or deselected, it triggers both a search event and a query to the Search API, hence considered in the calculation. However, navigating between search result pages by clicking a page number triggers a query but not a search event, hence not considered in the calculation.

For example, a search event followed by a click on two facets, and then a click on a result, leads to a clickthrough rate of 33.33% (1/3*100). If you do the same search event but use the page numbers to navigate to the desired result, the clickthrough would be 100% (1/1*100).

Manual Search Event Count

This metric is the total number of queries performed by users (using the search box) for the specified dimensions and filters. In usage analytics, a manual search is defined as a search where the Search Cause dimension contains one of the following values:

  • didyoumeanAutomatic

  • didyoumeanClick

  • searchboxSubmit

  • searchboxAsYouType

  • omniboxSearch

  • omniboxAnalytics

  • omniboxFromLink

  • omniboxField

  • searchFromLink

Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Number of Results Maximum

This metric is the highest number of results returned by the search interface for the specified dimensions and filters.

Number of Results Minimum

This metric is the lowest number of results returned by the search interface for the specified dimensions and filters.

Number of Results Sum

This metric is the total number of results returned by the search interface for the specified dimensions and filters.

Search Event Count

This metric is the total number of queries for the specified dimensions and filters.

Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Refined Search Event Count

This metric is the number of query refinements done by users (facet, interface change, etc.) for the specified dimensions and filters.

Note

The search cause of the related event must be manual for a query to count.
Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Response Time (ms) Maximum

This metric is the longest time in milliseconds the search interface took to return results for the specified dimensions and filters.

Response Time (ms) Minimum

This metric is the shortest time in milliseconds the search interface took to return results for the specified dimensions and filters.

Response Time (ms) Sum

This metric is the total time in milliseconds the search interface took to return results for the specified dimensions and filters.

Unique [Search Dimension Name]

This metric is the number of unique dimension value for the specified dimensions and filters (see Search dimensions).

Example

The Unique User Query metric is the number of unique queries entered by users in the search box for the specified criteria. If ten people performs the same exact query (for example, wireless headphones), this query is counted as one in the Unique User Query metric.

Custom metrics

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.

Attach to Case Count

This metric is the total number of times agents attached a result to a case (caseAttach event) for the specified dimensions and filters.

Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Custom Event Count

This metric is the total number of custom events for the specified dimensions and filters. In a metric card, in a dashboard without filters, the Custom Event Count is the sum of all custom events (see (Custom) Event Type).

Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Unique [Custom Dimension Name]

This metric is the number of unique dimension value for the specified dimensions and filters (see Search dimensions).

Example

The Unique Custom Event Value metric is the number of unique values saved for a custom event performed in a search interface, for the specified criteria.

All event type (click, search, and custom) metrics

Unique [All Event Type Dimension Name]

This metric is the number of unique dimension value for the specified dimensions and filters (see Search dimensions).

Example

The Unique City metric is the number of unique cities from which a user performed an event, based on the IP address, for the specified criteria.

Unique Client ID

This metric measures the number of unique client IDs that perform a query for the selected filters and dimensions (see What’s the client ID).

Unique User IP

This metric measures the number of unique IP addresses for the specified filters and dimensions. Sometimes, different users can share the same IP address.

Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Unique User ID

This metric measures the number of unique user IDs that perform a query for the selected filters and dimensions (see User ID).

Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Unique Visitor ID

This metric measures the number of unique visitors for the specified filters and dimensions. A visitor ID is based on persistent cookies, so a visitor keeps the same ID as long as they use the same browser and never clear the browser cookies. The visitor ID is a generated random sequence and doesn’t allow to personally identify an anonymous user.

Note

Third-party cookies will eventually be deprecated, therefore we recommend using the Unique Client ID metric instead.
Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Visit Clickthrough (%)

This metric measures the number of visits with at least one click divided by the total number of visits.

Note

This metric is only available when adding visit metric cards (see Add Visit metric cards).
Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Visit Count

This metric measures the number of visits regardless of unique IP addresses and user names for the specified filters and dimensions. Visits are based on time-based cookies. A visit ends after 30 minutes of inactivity.

Visits With Clicks

This metric measures the number of visits with at least one click.

Note

This metric is only available when adding visit metric cards (see Add Visit metric cards).
Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.

Visits With Manual Search Events

This metric measures the number of visits with at least one query performed by a user using the search box.

Notes

  • This metric is only available when adding visit metric cards (see Add Visit metric cards).

  • User query refinements are excluded.
Tip

For the related SQL expression that can be added to a query in the Snowflake reader account, see SQL expressions reference.