Use the Usage Analytics Read API

This is for:

In this article

The Usage Analytics Read API service allows you to access and manipulate the data you logged via the Usage Analytics Write API.

Search integrations with the Coveo typically rely on the Administration Console reports rather than on the Usage Analytics Read API directly (see Reports).

The articles in this section are only relevant if your use case isn’t met by the Administration Console:

combinedData request
Create and retrieve data exports
Filter syntax
List named filters
List dimensions
List metrics

A typical situation in which you would want to use the Usage Analytics Read API directly is to retrieve content available in the Administration Console in order to use it in your own application. For example, you may want to retrieve metric values for specific dimensions (see Perform a combinedData Request).

Interactive generated reference documentation is also available through Swagger UI (see Coveo Platform API - Usage Analytics Read API).