---
title: Coveo UA Protocol
slug: o1n91392
canonical_url: https://docs.coveo.com/en/o1n91392/
collection: coveo-for-commerce
source_format: adoc
---
# Coveo UA Protocol
> **Important**
>
> We strongly recommend that all new Commerce implementations use the [Event Protocol](https://docs.coveo.com/en/o1n91230/) to log events.

This article guides you on how to log [events](https://docs.coveo.com/en/260/) using [Coveo Analytics](https://docs.coveo.com/en/182/) for Coveo for Commerce.
It covers the various events to implement, as well as prerequisites and best practices.

Commands and actions, as well as global and product data fields, can be found on the [Commerce UA API reference](https://docs.coveo.com/en/l29e0540/) page.

> **Note**
>
> It's recommended to use the newer [Event Protocol](https://docs.coveo.com/en/o1n91230/) for new Coveo for Commerce implementations.
> For existing implementations, continue using Coveo UA as content is developed to assist in your migration to the Event Protocol.
> 
> To learn more about the differences between the two protocols, see [Log commerce events](https://docs.coveo.com/en/3188/).

## Prerequisites

. Access to a [Coveo organization](https://docs.coveo.com/en/185/) that you can manage from the [Administration Console](https://docs.coveo.com/en/1841/).
If you have never used the [Coveo Administration Console](https://docs.coveo.com/en/183/) before, [log in now](https://docs.coveo.com/en/1697/).

> **Notes**
>
> * Contact [Coveo Sales](https://www.coveo.com/en/contact) to enable Coveo for Commerce features in your organization.
> 
> * You can review your organization [license limits](https://docs.coveo.com/en/1562/) in the Administration Console.
> 
> * Ensure that you set the [required privileges](https://docs.coveo.com/en/3151/) for your commerce organization.

. To [use the Coveo UA library](https://docs.coveo.com/en/1818/), authentication credentials need to be passed in the form of an [API key](https://docs.coveo.com/en/1718/).

The Coveo UA library can send events to the [Coveo Analytics](https://docs.coveo.com/en/182/) service.
See [Initialize the Coveo UA JavaScript](https://docs.coveo.com/en/l2bf0354/).


## Capture events

Capturing commerce events allows you to trace a user's journey through your commerce site by providing accurate data on the user's interaction with various elements on your site.
Commerce-specific events include events such as product detail view, cart, and purchase.

### Search events

One of the most common types of logged events occurs when an end user interacts with a search interface, triggering a query to the Search API.

To learn more about how to send a search event, see [Capture a search event](https://docs.coveo.com/en/n7o80165/).

### Click events

It's important to record interactions when a user clicks specific elements, such as products or recommendations, within an ecommerce website or application.

For more information on how to send a click event, see [Capturing a click event](https://docs.coveo.com/en/n6mf0358/).

### Product detail view

Product detail view events are logged whenever a user accesses a [product detail page](https://docs.coveo.com/en/n8ad7392/) to view more information about that product.

To learn more about how to log a product detail view event, see [Capture a product detail event](https://docs.coveo.com/en/l2pd0522/).

### Cart modification and purchase events

The same principles apply when you [capture cart events](https://docs.coveo.com/en/n39h1594/) and [capture purchase events](https://docs.coveo.com/en/l39m0327/).

### Page views (deprecated)

Page views are used to measure user behavior. For more information about these events, see [Capture page views](https://docs.coveo.com/en/l3am0254/).

## Event validation

[Data validation](https://docs.coveo.com/en/n8492323/) ensures the accuracy of data sent to Coveo, which is crucial for the effectiveness of [Coveo Machine Learning (Coveo ML)](https://docs.coveo.com/en/188/) algorithms.
Additionally, accurate event data is vital for measuring [visitor](https://docs.coveo.com/en/nbub9475/) interactions, conversions, and revenue, as it forms the basis for reporting in Coveo experiences.

## Measure and optimize the personalization experience

The collected data also feeds [attribution](https://docs.coveo.com/en/m7l98577/) [dashboards](https://docs.coveo.com/en/256/), which you can review on the [Data Health dashboard](https://docs.coveo.com/en/m44f6381/), and [machine learning (ML)](https://docs.coveo.com/en/188/) [models](https://docs.coveo.com/en/1012/) which will ultimately help fine-tune the relevance of your site.
The built-in dashboards in the Administration Console let you [review your data health](https://docs.coveo.com/en/m44f6381/).