Adobe Commerce storefront events

When you install Adobe Commerce, storefront events are deployed to your site. These events capture data from shoppers' interactions on your site. When you install and configure SaaS-based Adobe Commerce features such as Product Recommendations, Live Search, or Data Connection the modules deploy behavioral data collection to your storefront for specific events. This mechanism collects anonymized behavioral data from the events and help to power Product Recommendations and Live Search or in the case of Data Connection, send that behavioral data to the Adobe Experience Platform.

Adobe provides an eventing framework that you can use to programmatically access Adobe Commerce storefront events.

If you are using the Data Connection module, the module deploys the eventing framework for you. Learn more.

Adobe Commerce Storefront Events SDK—Provides access to a common data layer and an event publishing/subscription service.
Adobe Commerce Storefront Events Collector—Listens for and handles events sent from the SDK.

Available events based on module

The following section lists the events from which each module collects behavioral data.

Product Recommendations and Live Search also use other non-module specific events to populate dashboards, inform ranking strategies, and help Adobe Sensei interpret shopper data correctly.

Product Recommendations

The Product Recommendations module collects behavioral data from the following events:

Although Product Recommendation metrics are optimized for Luma storefronts, they also work with other storefront implementations:

Required dashboard events

The following events are required to populate the Product Recommendations dashboard.

If your dashboard does not display any statistics, ensure that the required events are implemented and being tracked on your site. See Verify event collection.

Dashboard column	Events	Join field
Impressions	`page-view`, `recs-request-sent`, `recs-response-received`, `recs-unit-render`	`unitId`
Views	`page-view`, `recs-request-sent`, `recs-response-received`, `recs-unit-render`, `recs-unit-view`	`unitId`
Clicks	`page-view`, `recs-request-sent`, `recs-response-received`, `recs-item-click`, `recs-add-to-cart-click`	`unitId`
Revenue	`page-view`, `recs-request-sent`, `recs-response-received`, `recs-item-click`, `recs-add-to-cart-click`, `place-order`	`unitId`, `sku`, `parentSku`
LT Revenue	`page-view`, `recs-request-sent`, `recs-response-received`, `recs-item-click`, `recs-add-to-cart-click`, `place-order`	`unitId`, `sku`, `parentSku`
CTR	`page-view`, `recs-request-sent`, `recs-response-received`, `recs-unit-render`, `recs-item-click`, `recs-add-to-cart-click`	`unitId`, `sku`, `parentSku`
vCTR	`page-view`, `recs-request-sent`, `recs-response-received`, `recs-unit-render`, `recs-unit-view`, `recs-item-click`, `recs-add-to-cart-click`	`unitId`, `sku`, `parentSku`

The following events are not specific to Product Recommendations, but are required for Adobe Sensei to interpret shopper data correctly:

view
add-to-cart
place-order

Recommendation Type

This table describes the events used by each recommendation type.

Recommendation Type	Events	Page
Most Viewed	`page-view`, `product-view`	Product detail page
Most Purchased	`page-view`, `place-order`	Cart/Checkout
Most added to cart	`page-view`, `add-to-cart`	Product detail page, Product listing page, Cart, Wish List
Viewed this, viewed that	`page-view`, `product-view`	Product detail page
Viewed this, bought that	Product Recs	`page-view`, `product-view`
Bought this, bought that	Product Recs	`page-view`, `product-view`
Trending	`page-view`, `product-view`	Product detail page
Conversion: View to purchase	Product Recs	`page-view`, `product-view`
Conversion: View to purchase	Product Recs	`page-view`, `place-order`
Conversion: View to cart	Product Recs	`page-view`, `product-view`
Conversion: View to cart	Product Recs	`page-view`, `add-to-cart`

Live Search

The Live Search module collects behavioral data from the following events:

searchProductClick
searchRequestSent (also part of the Data Connection list.)
searchResponseReceived (also part of the Data Connection list.)
searchResultsView
searchSuggestionClick

Events used for ranking strategy

The following table describes the events used by Live Search ranking strategies.

Ranking Strategy	Events	Page
Most Viewed	`page-view`, `product-view`	Product detail page
Most Purchased	`page-view`, `place-order`	Cart/Checkout
Most added to cart	`page-view`, `add-to-cart`	Product detail page, Product listing page, Cart, Wish List
Viewed this, viewed that	`page-view`, `product-view`	Product detail page

Data collection for the purposes of Live Search does not include personally identifiable information (PII). All user identifiers, such as cookie IDs and IP addresses, are strictly anonymized. Learn more.

Required dashboard events

Some events are required to populate the Live Search dashboard.

If your dashboard does not display any statistics, ensure that the required events are implemented and being tracked on your site. See Verify event collection.

Dashboard area	Events	Join field
Unique searches	`page-view`, `search-request-sent`, `search-response-received`	`searchRequestId`
Zero results searches	`page-view`, `search-request-sent`, `search-response-received`	`searchRequestId`
Zero results rate	`page-view`, `search-request-sent`, `search-response-received`	`searchRequestId`
Popular searches	`page-view`, `search-request-sent`, `search-response-received`	`searchRequestId`
Avg. click position	`page-view`, `search-request-sent`, `search-response-received`, `search-results-view`, `search-product-click`	`searchRequestId`
Click-through rate	`page-view`, `search-request-sent`, `search-response-received`, `search-results-view`, `search-product-click`	`searchRequestId`, `sku`, `parentSku`
Conversion rate	`page-view`, `search-request-sent`, `search-response-received`, `search-results-view`, `search-product-click`, `product-view`, `add-to-cart`, `place-order`	`searchRequestId`, `sku`, `parentSku`

Required contexts

All events require the Page and Storefront contexts. This should happen at the page level/storefront application layer rather than when generating individual events. For example, in a PHP storefront, the PHP application container is responsible for setting them at runtime.

Usage

Here is a sample implementation of the search-request-sent event:

const mse = window.magentoStorefrontEvents;

/* set in application container */
// mse.context.page(pageCtx);
// mse.context.setStorefrontInstance(storefrontCtx);

/* set before firing event */
mse.context.setSearchInput(searchInputCtx);
mse.publish.searchRequestSent("search-bar");
Copied to your clipboard
const mse = window.magentoStorefrontEvents;

/* set in application container */
// mse.context.page(pageCtx);
// mse.context.setStorefrontInstance(storefrontCtx);

/* set before firing event */
mse.context.setSearchInput(searchInputCtx);
mse.publish.searchRequestSent("search-bar");

Caveats

Ad blockers and privacy settings can prevent events from being captured and might cause the engagement and revenue metrics to be under-reported. Additionally, some events might not be sent due to shoppers leaving the page or network issues.
Headless implementations must implement eventing to power intelligent merchandising.

If Cookie Restriction Mode is enabled, Adobe Commerce does not collect behavioral data until the shopper consents to using cookies. If Cookie Restriction Mode is disabled, Adobe Commerce collects behavioral data by default.