v1
latestOpenAPI 3.0.32026-07-26134195287.9 KBGet Sensor Alerts
Returns all alerts for all (or subset of) sensors in an org over a specified time range.
The response will include a list of sensor alerts for the organization (or given devices), including the device that triggered the alert, the alert threshold, and start and end timestamp of the alert.
Query parameters
A comma separated list of sensor IDs.
The start of the time range for requested alerts. Formatted as a Unix timestamp in seconds. Default value is an hour from the current time.
The end of the time range for requested alerts. Formatted in Unix timestamp in seconds. Default value is the current time.
The number of items returned in a single response. Default is 100. Max is 200.
The pagination token used to fetch the next page of results.
Retrieves alerts only for the given fields.
Fields must be one or multiple comma separated values from <code>humidity</code>, <code>motion</code>, <code>noise_level</code>, <code>pm_2_5</code>, <code>pm_4_0</code>, <code>pm_1_0_0</code>, <code>tamper</code>, <code>temperature</code>, <code>tvoc</code>(SV11), <code>usa_air_quality_index</code>, <code>vape_index</code>, <code>carbon_dioxide</code>, <code>carbon_monoxide</code>, <code>barometric_pressure</code>, <code>formaldehyde</code>, <code>ambient_light</code>, <code>tvoc_index</code>(SV23/SV25),<code>heat_index</code>.
If left blank, alerts of all sensor types will be returned in the response.
Response
OK
Example response
{
"alert_events": [
{
"alert_event_id": "25e15d7d-b19f-44a6-89b7-d37e460ce928",
"device_id": "b9ca7d11-66e2-47f0-a09e-05d6765c756a",
"device_name": "Third Floor Main Conference Room",
"device_serial": "UAIS-FSIL-3UTO",
"end_time": 1641337171,
"is_above_max_event": true,
"most_extreme_value": 1085,
"reading": "tvoc",
"start_time": 1641337165,
"threshold": 1000
},
{
"alert_event_id": "a665798b-6203-4d0f-b544-479a3b2bab21",
"device_id": "9b19a448-9139-479f-85b8-2e336f67b5e7",
"device_name": "Mail Room",
"device_serial": "ZWO2-VPZ6-UULB",
"end_time": 1641334872,
"is_above_max_event": true,
"most_extreme_value": 1,
"reading": "motion",
"start_time": 1641334867,
"threshold": 1
}
],
"page_cursor": 2
}