/metrics/hourly/spaces

get

https://api.vergesense.com/metrics/hourly/spaces

Hourly metrics for spaces

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Response

Property	Type	Description
`local_date`	String	Local date, formatted 'YYYY-MM-DD'.
`local_hour`	Number	Local hour between 0-23.
`capacity`	Number	Capacity of the space which the metric belongs at the time when the metric was recorded.
`avg_person_count`	String	Average amount of people in space.
`min_person_count`	Number	Minimum amount of people in space.
`max_person_count`	Number	Maximum amount of people in space.
`minutes_actively_occupied`	String	Amount of minutes that the space was actively occupied.
`minutes_passively_occupied`	String	Amount of minutes that the space was passively occupied.
`avg_pct_utilization`	Number	Average percentage that the space was utilized, represented in decimal form.
`min_pct_utilization`	Number	Minimum percentage that the space was utilized, represented in decimal form.
`max_pct_utilization`	Number	Maximum percentage that the space was utilized, represented in decimal form.
`pct_time_actively_occupied`	String	Percentage of hour that the space was actively occupied, represented in decimal form.
`pct_time_passively_occupied`	String	Percentage of hour that the space was passively occupied, represented in decimal form.

Query Parameters

local_date and local_hour have 6 different comparison operators.

filter[<local_date/local_hour>][<operator>]=<value to filter against>

Operator	Description
`eq`	`==` is equal to
`not_eq`	`!=` is not equal to
`lt`	`<` is less than
`lte`	`<=` is less than or equal to
`gt`	`>` is greater than
`gte`	`>=` is greater than or equal to

Query Params

sort

string

Defaults to -local_date,local_hour

Comma separated list of attributes used to sort the collection. Use a negative(-) sign to reverse the order.

fields[metrics_hourly_space]

string

Limit attributes that are included in a request. Comma separated list of attributes.

page[number]

int32

Defaults to 1

Page number for pagination.

page[size]

int32

Defaults to 10

Amount of records to return per page. Limit is 1000.

filter[space_type.key]

string

Filter metrics based on its associated space type's key.

filter[space_type.name]

string

Filter metrics based on its associated space type's name.

filter[building_ref_id]

string

Filter metrics based on its associated space's building_ref_id.

filter[floor_ref_id]

string

Filter metrics based on its associated space's floor_ref_id.

filter[space_ref_id]

string

Filter metrics based on its associated space's space_ref_id.

filter[local_date][gte]

date

Defaults to 2020-11-01

Filter metrics where local_date is greater than or equal to value.

filter[local_date][lte]

date

Filter metrics where local_date is less than or equal to value.

filter[local_hour][gte]

int32

Defaults to 8

Number between 0-23. Filter metrics where local_hour is greater than or equal to value.

filter[local_hour][lte]

int32

Defaults to 16

Number between 0-23. Filter metrics where local_hour is less than or equal to value.

Responses

Response

Query Parameters

200200

400400