---
title: Use the Usage Analytics Write API
slug: '1430'
canonical_url: https://docs.coveo.com/en/1430/
collection: build-a-search-ui
source_format: adoc
---
# Use the Usage Analytics Write API
The Usage Analytics Write API service lets you log all user interactions with [search interfaces](https://docs.coveo.com/en/2741/) and, optionally, other interfaces, such as support case creation interfaces or your [indexed](https://docs.coveo.com/en/204/) web sites.
You can then use [Coveo Analytics reports](https://docs.coveo.com/en/266/) to monitor the usage and adoption of your Coveo-powered implementation.
[Coveo Machine Learning (Coveo ML)](https://docs.coveo.com/en/188/) [models](https://docs.coveo.com/en/1012/) feed the [Coveo Analytics events](https://docs.coveo.com/en/260/) to continuously improve the relevance of your search results, [query suggestions](https://docs.coveo.com/en/1015/), and [content recommendations](https://docs.coveo.com/en/1016/).

> **Notes**
>
> * Search integrations with the [Coveo Platform](https://docs.coveo.com/en/186/) typically rely on the [Coveo JavaScript Search Framework](https://docs.coveo.com/en/187/) or the [Atomic](https://docs.coveo.com/en/lcdf0264/) or [Headless](https://docs.coveo.com/en/lcdf0493/) libraries rather than on the Usage Analytics Write API (and other APIs) directly.
>  
> If, for some legitimate reason, you can't use the [JavaScript Search Framework](https://docs.coveo.com/en/187/) or the [Atomic](https://docs.coveo.com/en/lcdf0264/) or [Headless](https://docs.coveo.com/en/lcdf0493/) libraries in your custom search integration with the [Coveo Platform](https://docs.coveo.com/en/186/), see [Use the REST APIs to build a search UI](https://docs.coveo.com/en/1370/).
> 
> * {empty}
>  
> --
> All REST API string fields are case-sensitive unless otherwise specified.
> For example, [search queries aren't case-sensitive](https://docs.coveo.com/en/3074/).
> 
> To keep behavior consistent across the [Coveo Platform](https://docs.coveo.com/en/186/), the same value passed to different REST APIs must always be passed using the same case.
> For example, if the [unique product identifier](https://docs.coveo.com/en/n73f0502#define-a-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](https://docs.coveo.com/en/1373/) as well as documentation specific to each Usage Analytics Write API endpoint:

* [`search`](https://docs.coveo.com/en/1502/)

* [`click`](https://docs.coveo.com/en/2064/)

* [`custom`](https://docs.coveo.com/en/2650/)

* [`view`](https://docs.coveo.com/en/2651/)

* [`collect`](https://docs.coveo.com/en/l41i0031/)

It also includes a troubleshooting article that covers [UA Write API error codes](https://docs.coveo.com/en/1431/).

Interactive generated reference documentation is also available through the [Swagger UI](https://platform.cloud.coveo.com/docs?urls.primaryName=UsageAnalyticsWrite).