About Coveo for Salesforce usage analytics

This is for:

In this article

Accessing usage analytics reports
About usage analytics events
Sending custom events

By installing Coveo for Salesforce, you have access to your own Coveo organization, where you can access the usage analytics coming from your Coveo components.

Coveo components send events to the Coveo Usage Analytics (Coveo UA) service so that you can track what end users do with your search components.

Accessing usage analytics reports

You can review your usage analytics data by accessing your Coveo (platform-ca | platform-eu | platform-au) organization.

In the Analytics section, select:

Reports: For an overview of all your analytics, in graph and chart form (see Manage usage analytics reports).
Data Health: To monitor and measure your organization data integrity (see Event browser).
Visit Browser: For a detailed description of all events for each visit (see Review user visits with the Visit Browser).
Raw Data: To view and export usage analytics data such as clicks, groups, keywords, searches, and custom events (see Manage raw data).
Dimensions: To define dimensions on custom metadata (see Manage dimensions on custom metadata).
Named Filters: To create sets of filters that you can use on many reports (see Manage named filters).
Permission Filters: To create permission filters to restrict data access in reports (see Manage permission filters).
Incoherent Events: For a list of usage analytics events discarded by Coveo UA (see Review incoherent usage analytics events).

For more information on how to navigate and understand Coveo UA, see Coveo Usage Analytics overview.

About usage analytics events

A usage analytics event is any user interaction with a search interface, including but not limited to search, click, and custom events (see Usage analytics events).

The act of recording a search event relies on two elements: the Cause and the Dimension.

A Cause has a name and a type. It’s itself a dimension.

An example of a cause would be interfaceLoad or facetSelect.
A Dimension is a grouping of metadata key-value pairs principally exploited within the Coveo UA reports.

For examples of dimensions, see Usage analytics dimensions.

Sending custom events

To learn how to send custom usage analytics events, see Sending context information in Salesforce Lightning.