Product DocsMenu

Recommended Topics

Usage Analytics Dimensions

Dimensions are metadata gathered by the search interface and passed along with the performed event to indicate the context of the recorded event. You can use dimensions to better understand or filter metrics.

The available dimensions grouped by event type and in alphabetical order are:

Click Dimensions

Click Cause

The search user interface action that triggered the recorded event.

Note: The out-of-the-box Click Cause values presented below are generally populated with standard data sent to the database by the various search interfaces. Some user interface components may not be available in some search interfaces, and the usage analytics data sent may be customized. The corresponding Click Cause values may consequently appear empty or with non-documented values.

The possible Click Cause values are in alphabetical order (with their event category in parentheses):

  • documentOpen (DocumentView)

    Logged when a user clicks in the search results to open an item.

  • documentQuickView (DocumentView)

    Logged when a user clicks the Quick View link in the search results to preview an item.

Click Date Time

The date and time when the user performed the click.

Example: Sept 20 2014 3:09 PM

Click Origin 1 (Page/Hub)

The name of the search hub, a group of search interfaces, from which click events are performed.

Example: You can select this dimension to count all click events made from a specific search hub.

Note: You can also use the global Origin 1 (Page/Hub) or Origin 2 (Tab) dimensions when you want to refer to events of all types performed from a given search hub or page tab.

Click Origin 2 (Tab)

The name of the search tab within a search page from which click events are performed.

Click Rank

The position of the item on which the user performed the click.

Example: 5

Note: The Click Rank dimension comes with four custom metrics measuring the dimension sum, average, minimum, and maximum values: Average Click Rank, Click Rank Sum, Click Rank Minimum, and Click Rank Maximum (see Usage Analytics Metrics).

Click Ranking Modifier

The ranking modifier that affected the item on which the user performed the click.

Example: Top Results

Collection Name

The name of the collection containing the item on which the user performed the click.

Note: This dimension is only valid for Coveo for Sitecore and on-premises indexes. In the Coveo Cloud Platform, all sources are created in the Default collection.

Example: Internal Wikis

Document Author

When available, the author of the item on which the user performed the click.

Example: John Smith

Document Title

When available, the title or the ID of the item on which the user performed the click.

Example: Leveraging the Coveo Cloud Usage Analytics

Important: This dimension does not support permissions allowing the disclosure of potentially sensitive title content to all users reviewing usage analytics data. If you do not want users to see the item titles of items they normally do not have access to, use the Search result dimension. However, you will not be able to create filters on clicked item titles.

Note: This dimension is not available out of the box. You must create the dimension to report on it (see Managing Dimensions on Custom Metadata).

Document URL

When available, the URL of the item on which the user performed the click.

Example: http://onlinehelp.coveo.com/en/cloud/leveraging_the_coveo_cloud_usage_analytics.htm

Important: This dimension does not support permissions allowing the disclosure of potentially sensitive URL content to all users reviewing usage analytics data. If you do not want users to see the item URLs of items they normally do not have access to, use the Clicked Search Result dimension. However, you will not be able to create filters on clicked item URLs.

Note: This dimension is not available out of the box. You must create the dimension to report on it (see Managing Dimensions on Custom Metadata).

Query Pipeline

The name of the query pipeline that processes the user query. This dimensions can be used when you want to compare the performance of different query pipeline configurations. Currently, only the Default query pipeline is available.

Note: Query pipelines are only available in the Coveo Cloud Platform.

Example: Default

Search Result (formerly Document)

Depending on the configuration and user permissions, either the clicked search result title or its ID. When available, a link allows users to directly access the clicked search result.

Example: Coveo Cloud Analytics: How to leverage Coveo Cloud Analytics

Note:

By default, only the clicked search result IDs are stored in the usage analytics database to prevent disclosing to unauthorized users the clicked search result title/URL that could carry sensitive information. In most cases, the configuration allows authenticated users reviewing usage analytics data to see the clicked search result title and the link to the original clicked search result when they have the read permission to the clicked search result.

For non-secured content, the usage analytics can be configured to record clicked search result titles and URLs, in which case they can be viewed by all users reviewing usage analytics data.

(Coveo Cloud V1 only) For usage analytics of a cloud index, the administrator must set the Usage Analytics Document Title Source parameter to configure the method to retrieve the clicked search result titles in Usage Analytics dashboards (see Managing Your Coveo Cloud V1 Organization Settings).

(Coveo Cloud V1 only) For usage analytics of an on-premises index, the developer or the administrator must set the Search Endpoint parameter to allow the administration console to resolve clicked search result IDs to corresponding titles and links for authorized users (see Managing Your Coveo Cloud V1 Organization Settings).

Source Name

The name of the source containing the item on which the user performed the click.

Example: Salesforce - Knowledge - jsmith@besttech.com

User Agent

The string of the user agent, which was acting on behalf of the user when he performed the click. A user agent is a software, such as web browsers and plug-ins, that helps retrieving and rendering web content, as well as interacting with it.

Note: This dimension is mainly useful when debugging your search interface.

Example: Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/40.0.2214.115 Safari/537.36

Search Dimensions

Advanced Query Expression

When available, a hidden query expression that was not contained in the search box.

Example: @objecttype==Case

Has Clicks

Determines if in the last search event, the user performed at least one click in the search results list to access an item. The value is either true or false.

Has Results

Determines whether the last search event resulted in a query that returned at least one result. The value is either true or false.

Group

A group to which a user performing the search event belongs. When available, this dimension is very useful to discriminate how different groups of users take advantage of the search solution.

Example: The usage analytics shows that users from the Customer Support Department group perform much more queries and clicks then users from the Engineering Department group and that the type and source of information they use are different.

You can then look into the needs of the engineering users, deploy and promote a customized search interface optimized for their needs, train engineering users, and monitor the adoption impact.

Note: In search interfaces where the users are authenticated and group membership information is available, the search interface can be customized to resolve the groups to which users performing events belong and include this data to the information sent to the usage analytics service.

Keyword

A slice and dice of the query into keywords. The value is a single term.

Example: The query search interface security and the query search results generate the following four keywords: search, interface, security, and results.

Number of Results

The number or results returned when the user performed the search event.

Note: The Number or Results dimension comes with four custom metrics measuring the dimension sum, average, minimum, and maximum values: Average Number or Results, Number of Results Sum, Number of Results Minimum, and Number or Results Maximum (see Usage Analytics Metrics).

Pager Number

When available, the page number on which the user performed the search event.

Query

The query text entered by the user in the search box, ignoring hidden query parts.

Note: A search interface often adds hidden filters to the user query to transparently set the search interface scope.

Query Pipeline

The name of the query pipeline that processes the user query. This dimensions can be used when you want to compare the performance of different query pipeline configurations. Currently, only the Default query pipeline is available.

Note: Query pipelines are only available in the Coveo Cloud Platform.

Example: Default

Response Time (ms)

The time in milliseconds for the search interface to return results when the user performed the search event.

Note: The Response Time (ms) dimension comes with four custom metrics measuring the dimension sum, average, minimum, and maximum values: Average Response Time (ms), Response Time (ms) Sum, Response Time (ms) Minimum, and Response Time (ms) Maximum (see Usage Analytics Metrics).

Search Cause

The search user interface component or action that triggered the recorded search event.

Note: The out-of-the-box Search Cause values presented below are generally populated with standard data sent to the database by the various search interfaces. Some user interface components may be not available in some search interfaces and sent data may be customized. The corresponding Search Cause values may consequently appear empty or with non-documented values.

The possible Search Cause values are in alphabetical order (with their event category in parentheses):

  • breadcrumbFacet (PerformSearch - refinement)

    Logged when a user clears a value from the filter summary, typically located at the top of the search results.

  • breadcrumbResetAll (PerformSearch - refinement)

    Logged when a user clears all values from the filter summary, typically appearing at the top of the search results.

  • casecontextAdd/casecontextRemove (PerformSearch)

    In the context of Coveo for Salesforce, logged when a user checks or clears the Show only contextual result checkbox from the Side Panel.

  • contextRemove (PerformSearch - refinement)

    In the context of Coveo for Salesforce, logged when a user clicks Remove in the Related Content notification section of the Expanded Search Interface.

    Note: You cannot add a context in the full expanded search interface.

  • didyoumeanAutomatic (PerformSearch - manual)

    Logged when a potential misspell is detected in a submitted query that returns no results and a new corrected query is automatically generated. The original query is also logged with its original cause.

  • didyoumeanClick (PerformSearch - manual)

    Logged when a potential misspell is detected in a submitted query and the user clicks the Did you mean corrected suggestion to launch the corrected query. The original query is also logged with its original cause.

  • documentField (PerformSearch - refinement)

    Logged when a user clicks on a field value from an item field to add a filter.

  • documentTag (PerformSearch - refinement)

    Logged when a user clicks on a tag value from an item tag field to add a filter.

  • errorBack (PerformSearch)

    Logged when a user clicks the Back link after an error page.

  • errorClearQuery (PerformSearch)

    Logged when a user clears the query box after an error page.

  • errorRetry (PerformSearch)

    Logged when a user clicks the Retry link after an error page.

  • facetClearAll (PerformSearch - refinement)

    Logged when a user clicks the x to clear all filters of a facet.

  • facetDeselect (PerformSearch - refinement)

    Logged when a user clicks on a facet value to no longer filter on results containing this value.

  • facetExclude/facetUnexclude (PerformSearch - refinement)

    Logged when a user clicks on a facet value to filter out or not results containing this value.

  • facetRangeGraph (PerformSearch - manual)

    Logged when a user clicks on a graph bar inside a range selector facet, thus selecting a pre-defined calculated range.

  • facetRangeSlider (PerformSearch - manual)

    Logged when a user changes the range of a range selector facet.

  • facetSearch (PerformSearch)

    Logged when a user searches within a facet.

  • facetSelect (PerformSearch - refinement)

    Logged when a user clicks on a facet value to filter on results containing this value.

  • facetToggle (PerformSearch)

    Logged when a user toggles the Collapse/Expand icon.

  • interfaceChange (PerformSearch - refinement)

    Logged when a user clicks a tab to switch to a different search interface.

  • interfaceLoad (PerformSearch)

    In the context of Coveo for Salesforce, logged when an Insight Panel automatically sends a query to display similar items.

    Example: A Salesforce Side Panel shows similar cases to the one the support agent is currently trying to resolve.

  • omniboxAnalytics (PerformSearch - manual)

    Logged when a user clicks an Omnibox suggestion based on the usage analytics recorded queries.

  • omniboxFacet (PerformSearch - refinement)

    Logged when a user selects a facet filter from the Omnibox.

  • omniboxField (PerformSearch - manual)

    Logged when a user selects an Omnibox suggestion from a list built from values of a field.

    Example: In the search interface for an online help, the Omnibox suggestions present relevant topic titles gathered from the @systitle field.

  • pagerResize

    When the CoveoResultsPerPage component is included on the search page, logged when a user modifies the number of displayed results per page (see Coveo Component ResultsPerPage).

    Note: By default, the user can choose between 10, 25, 50 or 100 results per page.

  • resultsSort (PerformSearch)

    Logged when a user changes the sort criterion for the search results.

  • searchboxAsYouType (PerformSearch - manual)

    Logged when a query is automatically generated and results are displayed while a user is entering text in the search box, before he voluntarily submits the query.

    Note: When the search-as-you-type feature is enabled, a query is launched each time a user types a character in the search box. To prevent flooding the analytics database, searchboxAsYouType events are logged only when typing in the search box is pending for five seconds.

  • searchboxClear (PerformSearch)

    Logged when a user clicks a user interface component to empty the search box, such as clicking the x in the search box.

  • searchboxSubmit (PerformSearch - manual)

    Logged when a user launches a search by pressing the Enter key when the focus is on the search box or by clicking the search button.

  • searchFromLink (PerformSearch - manual)

    Logged when the search page loads with a query (#q= query string parameter), such as when a user clicks a link pointing to a search results page with a query or enters a query in a standalone search box that points to a search page.

    Example: A search box appears at the top of all pages of a website. When a user types a query in the search box, the full search page (on the current site or on another site) opens with the query and the search results.

Search Date Time

The date and time when the user performed the search.

Example: Sept 20 2014 3:09 PM

Search Is Contextual

Determines whether the search performed by the user was contextual to an item that modifies the results of the query (Coveo Insight Box to find related content, for instance) or not.

Note: The Search is contextual values are filled starting from the August 2014 Coveo for Salesforce package.

Search Origin 1 (Page/Hub)

The name of the search hub, a group of search interfaces, from which search events are performed.

Example: You can select this dimension to count all search events made from a specific search hub.

Note: You can also use the global Origin 1 (Page/Hub) or Origin 2 (Tab) dimensions when you want to refer to events of all types performed from a given search hub or page tab.

Search Origin 2 (Tab)

The name of the search tab within a search page from which search events are performed.

User Agent

The string of the user agent, which was acting on behalf of the user when he performed the search. A user agent is a software, such as web browsers and plug-ins, that helps retrieving and rendering web content, as well as interacting with it.

Note: This dimension is mainly useful when debugging your search interface.

Example: Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/40.0.2214.115 Safari/537.36

Custom Event Dimensions

Custom Event Date Time

The date and time when the user performed the custom event.

Example: Sept 20 2014 3:09 PM

Custom Event Value

The value saved with the custom event.

Example: In the context of a case deflection service portal, a user clicked the I solved my problem button.

Custom Event Origin 1 (Page/Hub)

The name of the search hub, a group of search interfaces, from which custom events are performed.

Example: You can select this dimension to count all page visit events made from a specific search hub, excluding other click and search events made from the same hub.

Note: You can also use the global Origin 1 (Page/Hub) or Origin 2 (Tab) dimensions when you want to refer to events of all types performed from a given search hub or page tab.

Custom Event Origin 2 (Tab)

The name of the search tab within a search page from which custom events are performed.

Event Type

The name identifying the custom event or its category.

Note: The out-of-the-box Event Type values presented below are generally populated with standard data sent to the database by the various search interfaces. Some user interface components may be not available in some search interfaces and sent data may be customized. The corresponding Event Type values may consequently appear empty or with non-documented values.

The possible Event Type values are in alphabetical order:

  • caseAttach/caseDetach

    In the context of Coveo for Salesforce, logged when a user attaches or detaches a knowledge base article to/from a case.

  • caseCreate

    In the context of some Coveo for Salesforce user interfaces, logged when a user creates a case.

  • customfiltersChange

    Logged when a user modifies a custom search filter or removes one from the breadcrumbs.

  • expandToFullUI

    In the context of Coveo for Salesforce, logged when a user switches from a search results list in the Side Panel to the Expanded Search using the Expanded Search icon .

  • preferencesChange

    Logged when a user selects or clears a search preference setting checkbox (for instance: Open emails in Outlook).

All Event Type (Click, Search and Custom) Dimensions

A/B Test Name

The name of the A/B test the search page in which the user performed the event is a part of.

A/B Test Version

The name of the query pipeline (used in an A/B test) that was effective on the search page the user performed the event.

AccountId,
AccountName Coveo for Salesforce v2.6 (November 2015)

When a user associated with a Salesforce contact performs actions on a JavaScript search page in Salesforce (such as in a Salesforce community search page), the account ID and account name associated with the user contact.

Browser

The web browser name with which the user performed the event. This information is extracted from the HTTP user agent identification.

Example: Chrome

Browser With Version

The web browser name and version with which the user performed the event. This information is extracted from the HTTP user agent identification.

Example: Chrome 49.0

City

When available, the city from which the user performed the event, based on the IP address.

Example: San Jose

Country

The country from which the user performed the event, based on the IP address.

Example: United States

Day

The day when the user performed the event.

Example: Sept 20, 2014

Device (deprecated)

An indication of the device used to perform the event. The value is the browser name when the event is performed from a computer or the device identification when a mobile device is used. This information is extracted from the HTTP user agent identification.

Note: The Device dimension cannot be added in new analytics reports. However, the dimension is still supported in existing reports containing the dimension prior to the May 7th 2016 release.

Once the Device (deprecated) dimension is removed from a card or a filter, the dimension cannot be included back.

Examples:

  • For a computer: Chrome or Firefox

  • For a mobile device: iPad or Android

Device Category

The category of the device with which the user performed the event. This information is extracted from the HTTP user agent identification.

Examples:

  • Personal computer

  • Smartphone

  • Tablet

Facet Title

When available, the title of the facet in which a value was selected when the user performed the event.

Notes:

  • The dimension is available in Coveo Cloud organizations created after August 1st, 2017.

  • When missing, you can add the dimension using the following configuration (see Managing Dimensions on Custom Metadata):

    Parameter Value
    Dimension name Facet Title
    API name c_facettitle
    Type Text
    Related Events Search, Click, Custom event

Facet Value

When available, the value of the facet that was selected when the user performed the event.

Notes:

  • The dimension is available in Coveo Cloud organizations created after August 1st, 2017.

  • When missing, you can add the dimension using the following configuration (see Managing Dimensions on Custom Metadata):

    Parameter Value
    Dimension name Facet Value
    API name c_facetvalue
    Type Text
    Related Events Search, Click, Custom event

Is Anonymous

Determines whether or not the user anonymously accessed the search interface. The value is either true or false.

Is internal

Determines if the event performed by the user was internal based on the user's IP address (see Specify Internal IPs). The value is either true or false.

Is Mobile

Determines if the device used by the user to perform the event was mobile. The value is either true or false.

Language

The language set in the browser used by the user to perform the event.

Example: A user in Germany uses a browser set to display information in German and accesses a Coveo search interface that presents information in English. In the usage analytics pages, the Language dimension value for events performed by this user will be German.

Note: A search interface or search application can be customized to override the language value reported by the browser.

Example: A French Coveo search interface can be customized to always report the Language dimension as French, independently from the language set in user browsers.

Operating System

The operating system of the device with which the user performed the event. This information is extracted from the HTTP user agent identification.

Examples:

  • Windows

  • Android

  • iOS

Operating System With Version

The device operating system and version with which the user performed the event. This information is extracted from the HTTP user agent identification.

Examples:

  • Windows 8.1

  • Android 6.0

  • OS X 10.11

Origin Context

When available, the context of the user who performed the event.

Note: No values for this dimension are logged yet.

Examples:

  • Community

  • Search page

  • Agent panel

  • Hosted search page

Month

The month when the user performed the event.

Example: May 2015

Origin 1 (Page/Hub) (formerly Search Hub)

The name of the search hub, a group of search interfaces, from which any type of events are performed.

Example: A company has a Customer Portals search hub regrouping all customer facing search interfaces and an Employee Portals search hub regrouping all search interfaces available to employees.

Note: This dimension is computed from individual Search Origin 1 (Page/Hub), Click Origin 1 (Page/Hub), and Custom Event Origin 1 (Page/Hub) event-type specific dimensions that you can use when you want to ensure you get only events of specific types.

Origin 2 (Tab) (formerly Search interface)

The name of a search interface from which any type of events are performed. Typically, search interfaces have different URLs.

Example: A company has an Online Help search interface and a Website search interface.

Origin 3 (Referrer)

The HTTP identifier of the page from which any type of event originates (see HTTP identifier).

In the context of Coveo for Salesforce, the URL of the component. In other cases, such as Coveo .NET Search UI (Coveo .NET Front-End 12.0.1242+ (June 2015)), Origin 3 values show the component name depending on the Coveo integration (ex: outlookSidebar, desktopSearchbar or sharepointSearchbox).

Region

When available, the region from which the user performed the event, based on the IP address.

Note: When unavailable, the continent from which the user performed the event is logged.

Example:

  • For events performed from the United States, the value is the state abbreviation, such as CA for California.

  • From Canada, the value is the province abbreviation, such as BC for British-Columbia.

User Agent

The string of the user agent, which was acting on behalf of the user when he performed the event. A user agent is a software, such as web browsers and plug-ins, that helps retrieving and rendering web content, as well as interacting with it.

Note: This dimension is mainly useful when debugging your search interface.

Example: Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/40.0.2214.115 Safari/537.36

User ID

When the authenticated user accessed the search interface, the authenticated user identifier such as his email address.

User Name

When the user is authenticated to the search interface, the display name of the user that performs the event.

Example: John Smith

Note: In Salesforce, the User Name is displayed as the e-mail of the user that performs the event.

Example: jsmith@besttech.com

Visit ID

When a user accessed the search interface, the generated unique ID for the visit. A visit ends after 30 minutes of inactivity.

Note: Since the November 20th 2015 release, the visit ID is persisted when a user switches from authenticated users to anonymous, or the contrary. When the user switches to a second authenticated user, a new visit ID is created.

Visitor ID

When the user anonymously accessed the search interface, the unique ID of the user that performs the events (see Unique Visitor ID metric).

Week

The week when the user performed the event.

Example: 20th, 2015

Note: Event causes names have all been changed and standardized with the August 2nd 2014 Coveo Cloud Platform release. The following table lists in alphabetical order the old and new event cause names. These name changes have no impact on historical data.

Old New
analyticsSuggestionInOmnibox omniboxAnalytics
BackAfterError errorBack
clearQueryAfterError errorClearQuery
clearQueryBox searchboxClear
didYouMeanSuggestionClicked didyoumeanClick
didYouMeanWithoutResults didyoumeanAutomatic
facetBreadcrumbClick breadcrumbFacet
facetClearAll facetClearAll
facetClick facetSelect
facetRangesGraphSelected facetRangeGraph
facetRangeSliderChange facetRangeSlider
FacetSearch facetSearch
facetSelectionInOmnibox omniboxFacet
facetSortClicked facetSortValues
facetToggleOperator facetToggle
fieldSuggestionInOmnibox omniboxField
firstSearch interfaceLoad
fieldValueClick documentField
interfaceChange interfaceChange
logFetchMore pagerScrolling
omniboxSearchClicked omniboxSearch
OpenCachedDocument documentQuickView
OpenDocument documentOpen
pageChange pagerNumber
pageChangeNext pagerNext
pageChangePrevious pagerPrevious
resetAllValuesFromBreadcrumb breadcrumbResetAll
retryQueryAfterError errorRetry
SearchContextRemoved contextRemove
sortClicked resultsSort
searchEnter searchboxSubmit
searchButtonClicked searchboxSubmit
searchAsYouType searchboxAsYouType