Incidents

This endpoint shows the list of incidents the current user can view in the site; such as Door Left Open alarm (DLO), tamper, Intruder Alarms and Low Battery Warnings.

This endpoint does not provide real-time data, there may be certain delay before incidents become available for querying.

This endpoint supports oData sorting and filtering, and follows the same conventions as other endpoints which we provide. However, it does not support oData pagination.

Pagination

Pagination for incidents is performed with the help of a continuation token. So instead of requesting a specific page using $skip/$top arguments, you always request the next page.

When you make the first request you will get continuation_token property in the response.

To request a second page, you need to provide this token as a value for a custom header:

CLP-Continuation-Token

IMPORTANT: You need to pass the whole JSON which you obtained in continuation_token property. In order to do so, you first need to unescape the string, because what you have here, is an escaped JSON string inside a JSON object.

You can unescape JSON programmatically or use one of the available online tools: https://www.freeformatter.com/json-escape.html

Your second request will look like this:

And in your second response you can get another continuation token, which you will use to fetch third page and so on.

If there is no continuation token returned, then it means there are no more results to your query.

NOTE: it may be, that you got zero items in your response, but still have a continuation token returned. That means, that the API didn’t find events in some partitions of the data storage, but there is still data left in other partitions. So you can use continuation token to fetch more. In other words, don’t rely on items array being empty to know there are no more events. Instead rely on continuation token value.

Page Size

You can define page size by using the standard oData $top argument:

GET {{url}}/v1.1/sites/:site_id/incidents?$orderby=local_date_time desc&$top=2

By default the page size is 20, the maximum page size you can choose is 100.

Sorting

If $orderby argument is not provided by the caller, we will ensure that sorting is stable and paging can still be used, but we won’t provide a default sorting property. So we strongly recommend you to include $orderby in your request and to sort by a property that makes sense to you. Properties such as local_date_time and utc_date_time are good candidates for this role.