Event Protocol

This is for:

Developer
Important

The Event Protocol and Coveo Relay are currently in open beta. If you’re interested in using the Event Protocol and Relay library, reach out to your Customer Success Manager (CSM).

This article guides you on how to log events using the Event Protocol for Coveo for Commerce. It covers the various events to implement, as well as prerequisites and best practices. Using Event Protocol facilitates clean data tracking, allowing the platform to enrich key commerce events such as click, detail, add and remove from cart, and purchase events with metadata from the catalog entity, including ec_category, ec_brand, and ec_item_group_id.

Note

For existing implementations using the Coveo UA Protocol, refer to the Coveo UA Protocol documentation.

Choosing your approach

Since there are several approaches for building product discovery interfaces, the approach you pick will determine how you log events.

Approach How to log events

Headless

Dedicated Headless controllers

Atomic

Dedicated Atomic components

Commerce API

Relay or Relay in Google Tag Manager1

  1. Although we recommend using one of the provided client-side libraries, if you’re unable to use them, you can log events directly by calling the Event API.

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 send events to Coveo, you must configure authentication credentials.

  3. Ensure that storefront associations are correctly configured in your organization. Proper storefront associations is critical for collected UA events to be enriched with your Coveo catalog’s metadata.

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.

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 log clicks, see Capture click events.

Product detail events

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 send these events, see Capture product view events.

Cart events

When a user modifies the content of their cart, a cart event needs to be sent.

For more information on how to log cart events, see Capture cart events.

Purchase events

After adding an item to their cart, a user can proceed to purchase the items in their cart. The purchase event is sent when the user completes the purchase.

To learn more about how these events, see Capture purchase events.

Data 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 usage analytics reporting in Coveo experiences.