Analytics Requests

Use POST /analytics/resource/{experienceId} for experience analysis requests. It accepts filters and all other request settings in the JSON payload.

For store-level analytics, use the sitewide endpoints:

  • POST /analytics/sitewide/snapshot — summary KPI metrics with period-over-period percent changes, with optional audience segmentation

  • POST /analytics/sitewide/timeseries — metric-over-time data with configurable granularity and optional audience segmentation

  • POST /analytics/sitewide/order-distribution — order value histogram (KDE/CDF) and unit mix breakdown

The legacy GET /analytics/resource/{experienceId} endpoint is deprecated, is available during the beta only as a compatibility path, and will be removed when the beta version ends.

GET /experiences-list supports optional limit, page, status, and category query parameters. page is 1-indexed (page >= 1). Valid status values: pending, started, ended, paused. Valid category values: experiment, personalization.

GET /experiences/{experienceId} returns a wrapped response body in the shape { "experience": { ... } }.

Last updated

Was this helpful?