v1

latestOpenAPI 3.0.32026-07-26134195287.9 KB
Alerts

Get Alerts

Returns alerts for an organization within a specified time range.

Alert types include camera offline, camera online, tamper, motion, crowd, and Person of Interest alerts.

Motion alerts include whether people and/or vehicles were detected.

Crowd alerts include the threshold set for the camera that detected the crowd and whether people or vehicles were detected.

Person of Interest alerts include the label set for the person.

get/cameras/v1/alerts

Query parameters

start_timeinteger

The start of the time range for requested notifications. Formatted as a Unix timestamp in seconds. Default value is an hour ago from the current time.

end_timeinteger

The end of the time range for requested notifications. Formatted as a Unix timestamp in seconds. Default value is the current time.

include_image_urlboolean

The flag to include/exclude image url for notification. Defaults to false.

page_tokenstring

The pagination token used to fetch the next page of results.

page_sizeinteger

The number of items returned in a single response. Default is 100. Max is 200.

notification_typestring

One or multiple comma separated values from <code>person_of_interest</code>, <code>license_plate_of_interest</code>, <code>tamper</code>, <code>crowd</code>, <code>motion</code>, <code>camera_offline</code>, <code>camera_online</code>, <code>line_crossing</code>, <code>loitering</code>.

Response

OK

next_page_tokenstring

The pagination token used to fetch the next page of results.