Usage Analytics Concepts

The articles in this section define concepts that will help you better understand how to leverage Coveo Cloud usage analytics data.

Essentially, events performed by end-users in Coveo search interfaces (and optionally in other web page types) are recorded by the usage analytics service in your Coveo Organization. You can then use the administration console Analytics pages to learn what end-users do by reviewing usage events, metrics, and dimensions in explorers and dashboards (see Usage Analytics Reports, Usage Analytics Recorded Events, Usage Analytics Dimensions, and Usage Analytics Metrics).

UA-DataSchema2

In more detail, out-of-the-box, Coveo search interfaces push a set of standard search-related events and associated dimensions to the Coveo Cloud usage analytics database on which metrics can be calculated.

A developer can also create a customData object to push custom metadata with standard search-related events and even with custom events (see Coveo component Analytics).

In the Coveo Cloud administration console, you must however map each customData object metadata to custom dimensions to make it available to dashboards and explorers (see Managing Dimensions on Custom Metadata).

Your community search provides results for your knowledge base (KB). In your KB system, a developer adds code to push KB page visit custom events and metadata (such as page title, site, URL, referrer…) in a customData object.

customData: {
  "pageTitle": "An awesome Page",
  "pageSite": "www.mysite.com",
  "pageUrl": "http://www.mysite.com/an_awesome_page",
  "pageReferrer": "http://anothersite.com/somepage",
  "pageLanguage": "English"
}

As soon as some page visit events are recorded, in the administration console, an administrator creates a custom dimension for each customData metadata so that they can be viewed along with other standard or custom dimensions in the Visit Browser and used in dashboards and explorers.