get https://api.vergesense.com/spaces/thresholds/crossings
Fetch all threshold crossings for spaces on a given day.
Response conforms to the JSON API spec https://jsonapi.org/.
Responses are limited to 1,000
threshold crossings after which pagination will take place.
Example Requests
Description | Query |
---|---|
Query for 1 day of data. | https://api.vergesense.com/spaces/thresholds/crossings?date=2022-08-02 |
Query for 1 hour of data. | https://api.vergesense.com/spaces/thresholds/crossings?filter[timestamp][gte]=2022-08-02T16:00:00Z&filter[timestamp][lt]=2022-08-02T17:00:00Z |
Response
Space Threshold Crossing Model
Field | Description | Data Type |
---|---|---|
id | Unique identifier for the threshold crossing in the form:[space id]|[timestamp] | String |
type | space_threshold_crossing | String |
attributes.space_id | The space (building/floor/space) that the threshold crossing was reported for | String |
attributes.threshold_id | The threshold that the threshold crossing was reported for | String |
attributes.timestamp | Timestamp of the crossing (UTC) | String |
attributes.direction | Direction of the crossing. in|out | String One of in or out . |
relationships.building | Only present if the crossing was reported for a building. Details included in the included top level response key. | Object|null |
relationships.floor | Only present if the crossing was reported for a floor. Details included in the included top level response key. | Object|null |
relationships.space | Only present if the crossing was reported for a space. Details included in the included top level response key. | Object|null |
relationships.threshold | The threshold that the crossing was associated with | Object |