Use the Usage Analytics Write API

This is for:

Developer
In this article

The usage analytics (UA) Write API service lets you log all user interactions with search interfaces and, optionally, other interfaces, such as support case creation interfaces or your indexed web sites. You can then use UA reports to monitor the usage and adoption of your Coveo-powered implementation. Coveo Machine Learning (Coveo ML) models feed the UA events to continuously improve the relevance of your search results, query suggestions, and content recommendations.

Notes

  • Search integrations with the Coveo Platform typically rely on the Coveo JavaScript Search Framework or the Atomic or Headless libraries rather than on the UA Write API (and other APIs) directly.

    If, for some legitimate reason, you can’t use the JavaScript Search Framework or the Atomic or Headless libraries in your custom search integration with the Coveo Platform, see Use the REST APIs to build a search UI.

  • 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.

Get started

This section includes a general article about logging UA events as well as documentation specific to each UA Write API endpoint:

It also includes a troubleshooting article that covers UA Write API error codes.

Interactive generated reference documentation is also available through the Swagger UI.