Use the Usage Analytics Read API

This is for:

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

Note

Search integrations with Coveo often rely on Coveo Administration Console Reports, instead of directly relying on the Usage Analytics Read API.

The articles in this section are only relevant if your use case isn’t met by the Administration Console (platform-ca | platform-eu | platform-au):

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

A common scenario for using the UA Read API directly is when you wish to access content within the Coveo Administration Console and integrate it into your own application. For example, you may want to retrieve and integrate 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).