Skip to content
The Merchant Engine
You are reading the unreleased documentation. No version is released yet, and these pages describe code that is not in a release.

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.

POST /v1/analytics/events

Section titled “POST /v1/analytics/events”

Ingest a storefront analytics event

Request body: IngestEventDto.

Responses:

  • 204: no description.

Schemas

Section titled “Schemas”

IngestEventDto

Section titled “IngestEventDto”
  • eventType (object, 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 ("fr", "en", "ar", optional).