Skip to main content
Skip table of contents

Список событий за день

Список событий аналитики за день. Максимальная разница между from и to 24 часа.

В ответе будет список событий, которые произошли за интервал времени, а внутри каждого события уже будет детализация когда оно было и с какой камеры.

Объекта камеры может не быть, потому что самой камеры может не существовать.

Если в заданный диапазон времени событий было более 250, то возвращается сгруппированный список событий

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

Дата, от которой будет осуществляться отображение событий

torequired

string

Дата, до которой будет осуществляться отображение событий

camerasrequired

array

Массив id камер, по которым будут отображаться события

eventsrequired

array

Массив значений для фильтрации по событиям аналитики

Response

200

Возвращает список событий аналитики

JSON
{
          "data": [
            {
              "event": {
                "id": 11,
                "name": "smoke-fire",
                "description": "Детекция дыма и огня",
                "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": "Папка, Название камеры",
                    "lat": null,
                    "lng": null,
                    "azimuth": null,
                    "has_sound": false,
                    "is_archive_recording": true,
                    "is_bridge": false,
                    "is_favorite": false,
                    "user_status": "active",
                    "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": "Папка, Название камеры",
                    "lat": null,
                    "lng": null,
                    "azimuth": null,
                    "has_sound": false,
                    "is_archive_recording": true,
                    "is_bridge": false,
                    "is_favorite": false,
                    "user_status": "active",
                    "name": "Название камеры"
                  },
                  "crop": null
                }
              ]
            },
            {
              "event": {
                "id": 7,
                "name": "unrecognized-plate-start",
                "description": "Номер не идентифицирован",
                "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": "Папка, Название камеры",
                    "lat": null,
                    "lng": null,
                    "azimuth": null,
                    "has_sound": false,
                    "is_archive_recording": true,
                    "is_bridge": false,
                    "is_favorite": false,
                    "user_status": "active",
                    "name": "Название камеры"
                  },
                  "crop": "base64_content"
                }
              ]
            }
          ],
          "grouped": false
        }
200

Возвращает список событий аналитики, сгруппированных по типу события и интервалу времени

JSON
{
          "data": [
            {
              "from": "2023-05-01T00:00:00.000000Z",
              "to": "2023-05-01T01:00:00.000000Z",
              "items": [
                {
                  "event": {
                    "id": 4,
                    "name": "recognized-face",
                    "description": "Лицо идентифицировано",
                    "color": "#07D4F0",
                    "analytic_type": "face"
                  },
                  "item": {
                    "count": "48"
                  }
                },
                {
                  "event": {
                    "id": 7,
                    "name": "unrecognized-plate-start",
                    "description": "Номер не идентифицирован",
                    "color": "#628BFF",
                    "analytic_type": "license_plate"
                  },
                  "item": {
                    "count": "21"
                  }
                },
                {
                  "event": {
                    "id": 6,
                    "name": "recognized-plate-start",
                    "description": "Номер идентифицирован",
                    "color": "#3EDE9B",
                    "analytic_type": "license_plate"
                  },
                  "item": {
                    "count": "19"
                  }
                },
                {
                  "event": {
                    "id": 9,
                    "name": "camera-obstacle",
                    "description": "Детекция повреждения / перекрытия / вандализма камеры",
                    "color": "#2542DF",
                    "analytic_type": "camera-obstacle"
                  },
                  "item": {
                    "count": "10"
                  }
                },
                {
                  "event": {
                    "id": 5,
                    "name": "unrecognized-face",
                    "description": "Лицо не идентифицировано",
                    "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": "Номер не идентифицирован",
                    "color": "#628BFF",
                    "analytic_type": "license_plate"
                  },
                  "item": {
                    "count": "21"
                  }
                },
                {
                  "event": {
                    "id": 6,
                    "name": "recognized-plate-start",
                    "description": "Номер идентифицирован",
                    "color": "#3EDE9B",
                    "analytic_type": "license_plate"
                  },
                  "item": {
                    "count": "18"
                  }
                },
                {
                  "event": {
                    "id": 4,
                    "name": "recognized-face",
                    "description": "Лицо идентифицировано",
                    "color": "#07D4F0",
                    "analytic_type": "face"
                  },
                  "item": {
                    "count": "60"
                  }
                },
                {
                  "event": {
                    "id": 5,
                    "name": "unrecognized-face",
                    "description": "Лицо не идентифицировано",
                    "color": "#91D4E2",
                    "analytic_type": "face"
                  },
                  "item": {
                    "count": "124"
                  }
                },
                {
                  "event": {
                    "id": 9,
                    "name": "camera-obstacle",
                    "description": "Детекция повреждения / перекрытия / вандализма камеры",
                    "color": "#2542DF",
                    "analytic_type": "camera-obstacle"
                  },
                  "item": {
                    "count": "13"
                  }
                }
              ]
            }
          ],
          "grouped": true
        }
401

Токен авторизации не передан или не валидный, см. Получение токена

422

Возвращает JSON объект с ошибкой, см. Валидация

Пример

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.