Coveo UA Protocol

This is for:

Developer

This article guides you on how to log events using Coveo Usage Analytics (Coveo UA) for Coveo for Commerce. It covers the various events to implement, as well as prerequisites and best practices.

Note

It’s recommended to use the newer Event Protocol 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.

Prerequisites

  1. Access to a Coveo organization that you can manage from the Administration Console. If you have never used the Coveo Administration Console before, log in now.

    Notes
    • Contact Coveo Sales to enable Coveo for Commerce features in your organization.

    • You can review your organization license limits in the Administration Console.

    • Ensure that you set the required privileges for your commerce organization.

  2. To use the Coveo UA library, authentication credentials need to be passed in the form of an API key.

    The Coveo UA library can send events to the Coveo UA service. See Initialize the Coveo UA JavaScript.

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.

Click events

It’s important to record interactions when a user clicks on 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.

Product detail view

Product detail view events are logged whenever a user accesses a {product-detail-page} 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.

Cart modification and purchase events

The same principles apply when you capture cart events and capture purchase events.

Page views (deprecated)

Page views are used to measure user behavior. For more information about these events, see Capture page views.

Event validation

Data validation ensures the accuracy of data sent to Coveo, which is crucial for the effectiveness of Coveo Machine Learning (Coveo ML) algorithms. Additionally, accurate event data is vital for measuring visitor 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 dashboards, which you can review on the Data Health dashboard, and machine learning (ML) models 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.

References

Commands and actions, as well as global and product data fields, can be found on the Commerce UA API reference page.