Skip to main content
Skip table of contents

Calendar of events

List of analytics events by day for a period. The maximum time difference between «from» and «to» is 31 days.

The response will only include the presence of an event for each day, not the number of events.

In this request, it is necessary to provide dates in the client's time zone to correctly process the days on which events occurred for the user

GET/api/v1/calendar

Headers

Authorization

Bearer token

Accept

application/json

X-Client

ios-cctv|android-cctv|thick-legal|web

X-UUID

unique device id

Body

fromrequired

string

Date from which events will be displayed

torequired

string

Date until which events will be displayed

camerasrequired

array

Array of camera IDs for which events will be displayed

eventsrequired

array

Array of values for filtering analytics events

Response

200

Returns statistics on the used analytics cases

JSON
{
                "2000-01-01" : [
                    {
                        "id": 5,
                        "name": "unrecognized-face",
                        "description": "Face not identified",
                        "color": "#91D4E2",
                        "analytic_type": "face"
                    },{
                        "id": 6,
                        "name": "recognized-face",
                        "description": "Face not identified",
                        "color": "#07D4F0",
                        "analytic_type": "face"
                    }
                ],
                "2000-01-02": [],
                "2000-01-03": []
            }
401

Authorization token not provided or invalid, see Obtaining a token

422

Returns a JSON object with an error, see Validation

Example

JSON
curl -k --location --request GET 'https://.navekscreen.video/api/v1/calendar?from=string&to=string&cameras=array&events=array' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id'
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.