POS Sales API
Real-time sales data from Toast POS
Deprecated upstream. This endpoint described the legacy analytics_api HTTP surface.
Live sales are synced by the live-sales-pipeline cron into staging tables and read from
local marts. See Analytics tips.
Overview
The POS Sales API provides access to current sales metrics aggregated from Toast POS. This data is used by staff when filing shift reports to compare actual performance against goals.
Endpoint
GET /api/analytics/sales
Authentication
Legacy: Required an ANALYTICS_API_KEY via the Authorization: Bearer header on the
decommissioned analytics_api service. Production reads from local staging/marts.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
locationId | query | string | The ID of the location to fetch sales for. |
date | query | string | ISO date (YYYY-MM-DD). |
Response
{
"totalSales": 1250.50,
"transactionCount": 45,
"averageCheck": 27.78
}