/metrics/spaces

Metrics for spaces aggregated by the requested interval

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response

PropertyTypeDescription
avg_person_countStringAverage amount of people in space.
min_person_countNumberMinimum amount of people in space.
mode_person_countNumberMost common amount of people in space.
max_person_countNumberMaximum amount of people in space.
minutes_actively_occupiedStringAmount of minutes that the space was actively occupied.
minutes_passively_occupiedStringAmount of minutes that the space was passively occupied.
timestampStringBeginning timestamp (UTC) of interval, formatted 'YYYY-MM-DDTHH:MM:SS.SSSZ'
mode_person_countNumberThe most common person count value during the time interval.
avg_person_count_when_usedNumberThe average person count when the space was in use.
Query Params
date-time
Defaults to 2025-05-05

Timestamp (UTC) that you would like the results to be greater than or equal to.

date-time
Defaults to 2025-05-06

Timestamp (UTC) that you would like the results to be less than or equal to.

int32

Filter metrics based on its associated space's unique building_id.

string

Filter metrics based on its associated space's building_ref_id.

int32
Defaults to 60

Interval (in minutes) to use for the bucketing of metrics data.

int32
Defaults to 1

Page number for pagination.

int32
Defaults to 10

Number of spaces to include per page. Limit is 1000.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json