Transactions
Count of completed transactions over the period.
Returns the count of completed transactions per period. One of five metrics returned by the shared metric/transactions/data route — this page focuses on sales_transaction_count. Other related metrics: Volume, Units, Average transaction value, Units per transaction.
Demographic-free. Point-of-sale records don’t carry visitor demographics, so age, gender, role, and taxonomy breakdowns aren’t applicable. Use
breakdownByDimensions: ["entity"]on every transactions request.
Body parameters
| Field | Type | Required | Description |
|---|---|---|---|
start | string (ISO 8601) | yes | Inclusive start timestamp with timezone |
end | string (ISO 8601) | yes | Inclusive end timestamp with timezone |
entities | string[] | yes | Array of location, organisation, or recording IDs (matching entityType) |
entityType | "location" | "organisation" | yes | Aggregation level |
facets | string[] | yes | What to include: segments, summary, aggregates |
aggregationPeriod | string | yes | Time granularity — see aggregation period options |
breakdownByDimensions | string[] | yes | Must be ["entity"] (no demographic breakdowns on transactions) |
insideRecordingTimes | boolean | no | true to restrict to opening hours only. Default false |
Example request
{
"action": "metric",
"data": {
"id": "req-tx-001",
"route": "transactions/data",
"body": {
"start": "2024-04-01T00:00:00.000Z",
"end": "2024-04-07T23:59:59.000Z",
"entities": ["64a1b2c3d4e5f6a7b8c9d0e3"],
"entityType": "location",
"breakdownByDimensions": ["entity"],
"facets": ["segments", "summary"],
"aggregationPeriod": "day"
}
}
}Example response
req-tx-001|0|0|{
"segments": [
{ "index": "2024-04-01T00:00:00.000", "location": "64a1b2c3d4e5f6a7b8c9d0e3", "sales_transaction_count": 184 },
{ "index": "2024-04-02T00:00:00.000", "location": "64a1b2c3d4e5f6a7b8c9d0e3", "sales_transaction_count": 168 }
],
"summary": [
{ "location": "64a1b2c3d4e5f6a7b8c9d0e3", "sales_transaction_count": 1284 }
],
"meta": {
"units": {
"sales_transaction_count": "number"
}
}
}The same route also returns sales_volume, sales_units, sales_atv, and sales_upt in a single response. Request multiple fields by combining facets and reading them from the same segment row.
Update frequency
Transactions update approximately every 30 minutes.