2026-04-21 Changelog

Reporting API (Beta). The Reporting API is a Cube-based REST API for querying sales, payments, customer, and catalog metrics. It provides a dynamic, metadata-driven interface through two universal endpoints:

• GET /v1/meta — Discover available cubes, views, measures, dimensions, and segments at runtime.
• POST /v1/load — Execute analytical queries against the discovered schema.

Key features:

• Views — Curated, pre-joined interfaces like Sales, ItemSales, and ModifierSales that simplify common reporting use cases. Views pre-filter to closed orders and provide human-readable dimensions.
• Cubes — Covering orders, payments, customers, items, inventory, and more for advanced, granular access.
• Automatic multi-cube joins — Combine measures from multiple cubes in a single query without specifying join conditions.
• Dynamic schema discovery — Applications that discover the schema at runtime via /v1/meta adapt automatically to new fields and cubes as they become available.

Authentication requires a personal access token or an OAuth token with the REPORTING_READ permission scope. For more information, see Getting Started.