Use the Usage Analytics Write API

This is for:

Developer
In this article

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

Note

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

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

How do I start?

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.