Skip to main content
Skip table of contents

List of events for the day

List of analytics events for a day. The maximum time difference between «from» and «to» is 24 hours.

The response will include a list of events that occurred within the specified time interval, and within each event, there will be details of when it occurred and from which camera.

There may not be a camera object because the camera itself may not exist.

If there were more than 250 events within the specified time range, a grouped list of events will be returned.

GET/api/v1/calendar/detailed

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 a list of analytics events

JSON
{
          "data": [
            {
              "event": {
                "id": 11,
                "name": "smoke-fire",
                "description": "Smoke and fire detection",
                "color": "#FF5A3F",
                "analytic_type": "smoke-fire"
              },
              "items": [
                {
                  "created_at": "2023-02-01T14:55:54.000000Z",
                  "camera": {
                    "id": 745,
                    "group_id": 98,
                    "status": "active",
                    "type": "media_server_v2",
                    "start_at": "2022-03-23 14:43:21",
                    "created_at": "2022-01-27 18:55:48",
                    "billing_id": null,
                    "pretty_name": "Folder, Camera name",
                    "lat": null,
                    "lng": null,
                    "azimuth": null,
                    "has_sound": false,
                    "is_archive_recording": true,
                    "is_bridge": false,
                    "is_favorite": false,
                    "user_status": "active",
                    "name": "Camera name"
                  },
                  "crop": null
                },
                {
                  "created_at": "2023-02-01T14:59:54.000000Z",
                  "camera": {
                    "id": 745,
                    "group_id": 98,
                    "status": "active",
                    "type": "media_server_v2",
                    "start_at": "2022-03-23 14:43:21",
                    "created_at": "2022-01-27 18:55:48",
                    "billing_id": null,
                    "pretty_name": "Folder, Camera name",
                    "lat": null,
                    "lng": null,
                    "azimuth": null,
                    "has_sound": false,
                    "is_archive_recording": true,
                    "is_bridge": false,
                    "is_favorite": false,
                    "user_status": "active",
                    "name": "Camera name"
                  },
                  "crop": null
                }
              ]
            },
            {
              "event": {
                "id": 7,
                "name": "unrecognized-plate-start",
                "description": "License plate not identified",
                "color": "#628BFF",
                "analytic_type": "license_plate"
              },
              "items": [
                {
                  "created_at": "2023-02-01T14:55:54.000000Z",
                  "camera": {
                    "id": 745,
                    "group_id": 98,
                    "status": "active",
                    "type": "media_server_v2",
                    "start_at": "2022-03-23 14:43:21",
                    "created_at": "2022-01-27 18:55:48",
                    "billing_id": null,
                    "pretty_name": "Folder, Camera name",
                    "lat": null,
                    "lng": null,
                    "azimuth": null,
                    "has_sound": false,
                    "is_archive_recording": true,
                    "is_bridge": false,
                    "is_favorite": false,
                    "user_status": "active",
                    "name": "Camera name"
                  },
                  "crop": "base64_content"
                }
              ]
            }
          ],
          "grouped": false
        }
200

Returns a list of analytics events grouped by event type and time interval

JSON
{
          "data": [
            {
              "from": "2023-05-01T00:00:00.000000Z",
              "to": "2023-05-01T01:00:00.000000Z",
              "items": [
                {
                  "event": {
                    "id": 4,
                    "name": "recognized-face",
                    "description": "Face identified",
                    "color": "#07D4F0",
                    "analytic_type": "face"
                  },
                  "item": {
                    "count": "48"
                  }
                },
                {
                  "event": {
                    "id": 7,
                    "name": "unrecognized-plate-start",
                    "description": "License plate not identified",
                    "color": "#628BFF",
                    "analytic_type": "license_plate"
                  },
                  "item": {
                    "count": "21"
                  }
                },
                {
                  "event": {
                    "id": 6,
                    "name": "recognized-plate-start",
                    "description": "License plate identified",
                    "color": "#3EDE9B",
                    "analytic_type": "license_plate"
                  },
                  "item": {
                    "count": "19"
                  }
                },
                {
                  "event": {
                    "id": 9,
                    "name": "camera-obstacle",
                    "description": "Camera damage / overlap / vandalism detection",
                    "color": "#2542DF",
                    "analytic_type": "camera-obstacle"
                  },
                  "item": {
                    "count": "10"
                  }
                },
                {
                  "event": {
                    "id": 5,
                    "name": "unrecognized-face",
                    "description": "Face not identified",
                    "color": "#91D4E2",
                    "analytic_type": "face"
                  },
                  "item": {
                    "count": "127"
                  }
                }
              ]
            },
            {
              "from": "2023-05-01T01:00:00.000000Z",
              "to": "2023-05-01T02:00:00.000000Z",
              "items": [
                {
                  "event": {
                    "id": 7,
                    "name": "unrecognized-plate-start",
                    "description": "License plate not identified",
                    "color": "#628BFF",
                    "analytic_type": "license_plate"
                  },
                  "item": {
                    "count": "21"
                  }
                },
                {
                  "event": {
                    "id": 6,
                    "name": "recognized-plate-start",
                    "description": "License plate identified",
                    "color": "#3EDE9B",
                    "analytic_type": "license_plate"
                  },
                  "item": {
                    "count": "18"
                  }
                },
                {
                  "event": {
                    "id": 4,
                    "name": "recognized-face",
                    "description": "Face identified",
                    "color": "#07D4F0",
                    "analytic_type": "face"
                  },
                  "item": {
                    "count": "60"
                  }
                },
                {
                  "event": {
                    "id": 5,
                    "name": "unrecognized-face",
                    "description": "Face not identified",
                    "color": "#91D4E2",
                    "analytic_type": "face"
                  },
                  "item": {
                    "count": "124"
                  }
                },
                {
                  "event": {
                    "id": 9,
                    "name": "camera-obstacle",
                    "description": "Camera damage / overlap / vandalism detection",
                    "color": "#2542DF",
                    "analytic_type": "camera-obstacle"
                  },
                  "item": {
                    "count": "13"
                  }
                }
              ]
            }
          ],
          "grouped": true
        }
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://vms.local/api/v1/calendar/detailed?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.