API ReferenceChangelog
HomeAPI ReferenceChangelog
API ReferenceChangelogLog In
API Reference

/metrics/hourly/spaces

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

Hourly metrics for spaces

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

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


Date Range Limits


filter[local_date] is required. A request without it returns 400 Must include local date filter.

A single request covers at most a week of dates. A wider range returns 400 Cannot request more than a week of data. Split a longer window into week-sized chunks and issue one request per chunk.

A request for one specific date is exempt from this limit. Pass filter[local_date]=2025-06-18 or filter[local_date][eq]=2025-06-18.


Filtering by Hour


filter[local_hour] has no default. If you omit it, the response covers all 24 hours of each day. Pass the filter to narrow the result and reduce the number of rows returned.

filter[local_hour][gte] must be lower than filter[local_hour][lte]. Equal or inverted values return 400 local_hour param order incorrect. To request a single hour, pass filter[local_hour]=8 or filter[local_hour][eq]=8.

Query Params
string
Defaults to -space_id,-local_date,-local_hour

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

string

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

int32
Defaults to 1

Page number for pagination.

int32
Defaults to 250

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

string

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

string

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

string

Filter metrics based on its associated space's building_ref_id.

string

Filter metrics based on its associated space's floor_ref_id.

string

Filter metrics based on its associated space's space_ref_id.

date

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

date

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

int32

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

int32

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

Responses

Updated about 2 months ago

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

Updated about 2 months ago