Usage Analytics Recorded Events

The Coveo Cloud usage analytics records search events performed by end-users in Coveo interfaces such as search pages and case creation panels built with the Coveo JavaScript Search Framework.

The recorded events are of the following categories:

  • Queries (PerformSearch)

    A query is registered from a search interface when an action is performed to send a search query to the Coveo index which returns updated search results. The action can be triggered by users or automatically.

    Queries can be separated into three different categories: manual query, which is done consciously by the user on a particular topic, automatic query (for technical purpose), which is triggered automatically without the user noticing, and manual (query) refinement. This last type of query comes from an action of the user (e.g., clicking a facet element), but still results in a new query, without being the main intent of the user.

    The following Coveo search interface actions are query events:

    • User entering keywords in the search box and clicking the search button (or pressing Enter).

    • User clicking to see the next search results page.

    • User clicking a facet element to refine results.

    • An automatic query is generated to provide default search results when a user initially accesses a search interface.

    The query events are used to calculate metrics such as Query Count.

  • Clicks (DocumentView)

    A click is registered from a search interface when a user clicks a link from the search results to access an item.

    The following Coveo search interface actions are click events:

    • Clicking a search result link to open the item in its original application such as a Case opening in Salesforce.

    • Clicking the Quick View link to open the item preview directly in the search interface.

    The click events are used to calculate metrics such as Average Click Rank and Click Count.

  • Page Views

    A page view is registered each time a user visits a page.

    The page view events provide data to Coveo Machine Learning (Coveo ML) for the Recommendations module (see Coveo Machine Learning Features).

  • Others (CustomEvent)

    Other events are those that neither generate a query nor access a search result item.

    The following Coveo search interface actions are custom events:

    • Modifying a custom search filter or removing one from the breadcrumbs.

    • Selecting or clearing a search preference setting checkbox (for instance: Open emails in Outlook).

The Search cause, Click cause, and Event type dimensions precisely identify the recorded event nature (see Search Cause, Click Cause and Event Type).