Log commerce events

Ecommerce Developer Product Documentation

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.

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

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

    The Coveo analytics library can send events to the Coveo UA service. See Initialize the Coveo Analytics 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. The typical events required are page views, search and clicks. Commerce specific events include Product detail view, cart and checkout process.

Page views

While not specific to commerce implementations, page views are an essential piece of information that needs to be collected to measure user behavior. A pageview event must be sent each time a user views a page of your site.

Search events

When a user views a set of search results following a query or in a recommendation interface.

Product detail view

Product detail views are logged whenever a user accesses a product detail page (PDP) to view more information about that product.

Cart modification and purchase events

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

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 and fix validation errors.

References

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