Max area occupancy
Peak observed occupancy in a defined area.
Returns the peak observed occupancy in a defined area for the period — the highest concurrent count recorded inside the zone.
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 |
areaType | "taxonomy" | "location-dwell" | yes | Required by all Area routes |
taxonomy | string[] | conditional | Required when areaType: "taxonomy" — see how taxonomies work |
facets | string[] | yes | What to include: segments, summary, aggregates, thumbnails, thumbnails-with-statelems |
aggregationPeriod | string | yes | Time granularity — see aggregation period options |
breakdownByDimensions | string[] | no | Split data by: entity, taxonomy, age, gender, role |
roles | string[] | conditional | Required when breakdownByDimensions includes role |
genders | string[] | conditional | Required when breakdownByDimensions includes gender |
ages | string[] | conditional | Required when breakdownByDimensions includes age |
insideRecordingTimes | boolean | no | true to restrict to opening hours only. Default false |
Example request
{
"action": "metric",
"data": {
"id": "req-amo-001",
"route": "area/max-occupancy",
"body": {
"start": "2024-04-01T00:00:00.000Z",
"end": "2024-04-07T23:59:59.000Z",
"entities": ["64a1b2c3d4e5f6a7b8c9d0e3"],
"entityType": "location",
"areaType": "taxonomy",
"taxonomy": ["Service:Checkout"],
"facets": ["segments", "summary"],
"aggregationPeriod": "day"
}
}
}Example response
req-amo-001|0|0|{
"segments": [
{ "index": "2024-04-01T00:00:00.000", "location": "64a1b2c3d4e5f6a7b8c9d0e3", "area_max_occupancy": 14 },
{ "index": "2024-04-02T00:00:00.000", "location": "64a1b2c3d4e5f6a7b8c9d0e3", "area_max_occupancy": 12 }
],
"summary": [
{ "location": "64a1b2c3d4e5f6a7b8c9d0e3", "area_max_occupancy": 18 }
],
"meta": {
"units": {
"area_max_occupancy": "peopleCount"
}
}
}Update frequency
Updated once every 24 hours, at 04:00 UK time.