Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Compare Chataigne channels within a location or locations within a business organization.
GET /v1/locations/{location_id}/analytics/channels
| Field | Meaning |
|---|---|
channels[].channel | Chataigne order channel, currently such as whatsapp or instagram. |
channels[].order_count | Eligible orders placed through that channel. |
channels[].average_order_value | Average order value for the channel after discounts, excluding delivery and service fees. |
daily_orders[] | Long-form daily rows with date, channel, and order_count. |
currency for every average order value.
{
"currency": "EUR",
"channels": [
{ "channel": "instagram", "order_count": 80, "average_order_value": 27.2 },
{ "channel": "whatsapp", "order_count": 240, "average_order_value": 26.4 }
],
"daily_orders": [{ "date": "2026-06-01", "channel": "whatsapp", "order_count": 10 }]
}
GET /v1/organizations/{organization_id}/analytics/locations
| Field | Meaning |
|---|---|
location_id | Canonical location identifier, safe to use in another /v1/locations/... request. |
name | Current location name. |
order_count | Eligible orders at this location. |
active_customer_count | Customers with an eligible order at this location during the period. |
returning_customer_rate | Percentage of active customers who have ordered at this location more than once. |
order_count from highest to lowest, then by name. Use the canonical id rather than the name when joining these rows with your own data.