Use the Usage Analytics Read API

This is for:

Business Analyst System Administrator

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

Notes

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

  • All REST API string fields are case-sensitive unless otherwise specified. For example, search queries aren’t case-sensitive.

    To keep behavior consistent across the Coveo Platform, the same value passed to different REST APIs must always be passed using the same case. For example, if the unique product identifier, such as ec_product_id, is passed to the Commerce API in lowercase, then it should also be passed to the Usage Analytics Write API in lowercase.

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):

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 the Swagger UI.