Mean occupancy for all zones in a tenant within a time range from start (inclusive) to end (exclusive) using a provided resolution.
Resolution can be set to 5m, 15m, 30m, 1h and determines the size of time intervals between the start and end (i.e., resolution set to 30m between 8:30 AM and 10:30 AM would produce occupancy estimates for intervals 8:30 AM, 9:00 AM, 9:30 AM, and 10:00 AM). Larger resolutions are preferred to reduce the size of the result set and the impact of outliers.
Result sets will include one row per interval per zone, and are ordered by the start_timestamp of the interval. Given a resolution of 15m and an interval timestamp of 3:00 PM, the mean_occupancy is the average occupancy from 3:00 PM (inclusive) to 3:15 PM (exclusive).
Currently all results are returned in a single page. The API rejects requests if the time range is too large for the selected resolution. Valid time ranges based on resolution are:
- 4 days at
5m - 2 weeks at
15m - 1 month at
30m - 2 months at
1h
In addition to the resolution/time range constrants, responses are limited to a maximum of 3 million rows. Response bodies larger than the row limit are truncated, dropping more recent data (based on ordering).
HTTP compression is enabled for responses larger than 500 bytes when the request includes "gzip" in the Accept-Encoding header.
Please note that Lambent Spaces does not produce occupancy in real time. Occupancies for a given time period may be delayed from 30 minutes to an hour, and this may be further increased due to ingestion lag or data availability from Wi-Fi source systems.
The zone occupancy endpoint is rate-limited to 60 requests per minute.