Skip to main content
The Analytics API exposes small, predictable resources for a location or an entire business organization. Request the business domain you need instead of selecting fields from one large response.

Financials

Revenue and average order value.

Orders

Order volume and time distributions.

Customers

Acquisition, retention, interactions, and conversion.

Delivery

Delivery failures, costs, fees, and cities.

Products

Item volume, best sellers, and trends.

Discounts

Redemptions and granted amounts.

Breakdowns

Location channels and organization locations.

​
Authentication and access

Send your API key in the x-api-key header. It must include the analytics.read permission. A valid key without access to the requested resource receives 403. An unknown canonical identifier receives 404.

​
Shared filters

​
string
Start of the period as an ISO 8601 timestamp. If from and to are both omitted, the period starts 30 days before the request.
​
string
End of the period as an ISO 8601 timestamp. If from and to are both omitted, the period ends when the request is processed.
​
string
Optional order-service filter: delivery or collection.
Every response echoes the effective filters in period. There is no metric-selection parameter: each endpoint always returns its complete, fixed schema.

​
Data conventions

  • Order-backed statistics cover confirmed and in-progress orders placed through Chataigne on WhatsApp or Instagram. Failed orders and deliveries appear only in their dedicated fields.
  • Monetary location responses include currency. Monetary organization responses use by_currency, so amounts in different currencies are never added together.
  • Daily and hourly values use each location’s configured timezone. An organization day therefore follows the local calendar day of each contributing location.
  • Rates are percentages from 0 to 100, not decimal fractions.
  • Daily series use explicit rows such as { "date": "2026-06-01", "order_count": 12 }. Missing dates are not returned as zero rows.
Start with Financials, or open the generated Analytics API reference for the complete request and response schemas.