For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
  • Overview
    • Quick Start
    • Sandboxes
    • Tools & SDKs
    • Support
  • Docs
    • Archive
    • Closed Beta Programs
        • Overview
        • Getting Started
        • Catalog Data
        • ML Models
        • Request Recommendations
        • Search
        • Shopper Events
        • Stencil Headless Catalyst
        • API Reference
Dev Portal
LogoLogo
On this page
  • Real-time shopper events
  • Shopper event schema
Closed Beta ProgramsProduct Recommendations

Shopper Events

Beta
Was this page helpful?
Previous

Search

Next

Stencil Headless Catalyst

Built with

Real-time shopper events

To ensure product recommendations are up to date, BigCommerce sends new shopper events in near real-time. The real-time eventing pipeline trains ML models by sending shopper events along with attribution tokens to associate shopper responses with recommended products.

Shopper event schema

BigCommerce sends the following data to your GCP account for the supported events:

Product Detail Page View Event

var user_event = {
"eventType": "detail-page-view",
"visitorId": "visitor-id",
"attribution_token": "Token retrieved from Google as part of prediction request."
"productDetails": [{
"product": {
"id": "product-id"
}
}]
};

Purchase Complete Event

var user_event = {
"eventType": "purchase-complete",
"visitorId": "visitor-id",
"attribution_token": "Token retrieved from Google as part of prediction request."
"productDetails": [{
"product": {
"id": "product-id"
},
"quantity": product-quantity
}],
"purchaseTransaction": {
"revenue": revenue,
"currencyCode": "currency-code"
}
};

We will add the following user events in the future:

  • add-to-cart
  • category-page-view
  • home-page-view
  • search
  • shopping-cart-page-view

For a more detailed explanation about each field, see the User Events article in the Google documentation.