Skip to content

Analytics (storefront API)

Storefront and customer routes of the analytics module. Send Accept-Language (or X-Locale from a browser) on every call; a customer route needs the session cookie.

Ingest a storefront analytics event

Request body: IngestEventDto.

Responses:

  • 204: no description.
  • eventType ("add_payment_info", "add_shipping_info", "add_to_cart", "begin_checkout", "page_view", "product_view", "purchase", "search", required).
  • sessionId (string, pattern ^[A-Za-z0-9_-]+$, max length 128, optional).
  • userId (string, optional).
  • productId (string, optional).
  • orderId (string, optional).
  • data (object, optional).
  • locale (string, optional).
As seen on Open Source Alternatives The Merchant Engine badge