Summarize visitor traffic
Summarizes physical footfall over a period: a per-bucket series (`bucket` = hour|day|week|month) with period totals (pax, entries, exits, sample count, and the busiest bucket). Filter by `location_id` or `sensor_id`; pass `since` for the lower bound. Pass `show_id` to also return that show's traffic lift vs the gallery daily average.
Summarizes physical footfall over a period: a per-bucket series (bucket = hour|day|week|month) with period totals (pax, entries, exits, sample count, and the busiest bucket). Filter by location_id or sensor_id; pass since for the lower bound. Pass show_id to also return that show's traffic lift vs the gallery daily average.
Authorization
bearerAuth traffic:readA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: traffic:read
Query Parameters
"day"Value in
- "hour"
- "day"
- "week"
- "month"
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$dateResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "bucket": "hour", "totals": { "pax": -9007199254740991, "entries": -9007199254740991, "exits": -9007199254740991, "sample_count": -9007199254740991, "peak_bucket_start": "string" }, "series": [ { "bucket_start": "string", "pax": -9007199254740991, "entries": -9007199254740991, "exits": -9007199254740991, "occupancy_avg": 0, "dwell_ms_sum": -9007199254740991, "dwell_count": -9007199254740991, "sample_count": -9007199254740991 } ], "show_lift": { "show_id": "string", "title": "string", "opening_date": "string", "pax_total": -9007199254740991, "active_days": -9007199254740991, "show_daily": 0, "gallery_daily": 0, "lift_ratio": 0, "opening_pax": -9007199254740991 }}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}