Statistics

Retrieve aggregated items and modifications with pagination.

Query Routing: Automatically routes to BigQuery for historical data (>24 hours) or PostgreSQL for recent data.

Item Types:

• regular_item - Normal menu items
• Other types - Item modifications (extras)

Use Cases:

• Item sales reports
• Menu performance analysis
• VAT reporting

Permissions: 🔵 statistics.read

Retrieve sale summary with items, extras (modifications), and tips for a date range.

Query Routing: Automatically routes to BigQuery for historical data (>24 hours) or PostgreSQL for recent data.

Response includes:

• Items sold with VAT breakdown
• Item modifications (extras) with VAT breakdown
• Total tips
• Summary totals

Permissions: 🔵 statistics.read

Retrieve time series data for a specific metric across locations and date range.

Query Routing: Automatically routes to BigQuery for historical data (>24 hours) or PostgreSQL for recent data.

Available Metrics:

• gmv - Gross Merchandise Value
• orders_count - Number of orders
• sold_count - Number of items sold
• tips_amount - Total tips amount
• saved_co2 - CO2 saved (grams)
• pushes_sent - Push notifications sent

Target Options:

• aggregated - Combine all locations into single series
• locations - Return separate series per location

Permissions: 🔵 statistics.read

Retrieve time series data for MULTIPLE metrics in a single request. Much more efficient than calling the single-metric endpoint multiple times.

Query Routing: Automatically routes to BigQuery for historical data (>24 hours) or PostgreSQL for recent data.

Available Metrics (comma-separated):

• gmv - Gross Merchandise Value
• orders_count - Number of orders
• sold_count - Number of items sold
• tips_amount - Total tips amount
• saved_co2 - CO2 saved (grams)
• pushes_sent - Push notifications sent

Target Options:

• aggregated - Combine all locations into single series
• locations - Return separate series per location

Example: /api/v1/statistics/time-series-batch?metrics=gmv,orders_count,sold_count&locationIds=100,101&startDate=2025-01-01&endDate=2025-01-31

Permissions: 🔵 statistics.read

Retrieve tips for a location and date range.

Query Routing: Automatically routes to BigQuery for historical data (>24 hours) or PostgreSQL for recent data.

Response includes:

• Tips by date with VAT breakdown
• Total amounts and counts

Permissions: 🔵 statistics.read