Skip to main content
Skip table of contents

Аналитика. Дашборд

Статистика по событиям аналитики за период

GET/api/v1/events/dashboard/analytics/detailed

Headers

Authorization

Bearer token

Accept

application/json

X-Client

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

X-UUID

unique device id

Body

daterequired

string

Шаблон для фильтрации по дате. Это поля обязательно, когда нет фильтрации по полям from, to

timezonerequired

string

Часовой пояс для шаблон фильтрации по дате. Пример - Europe/Paris. Это поля обязательно при фильтрации по полю дате

fromrequired

string

Дата от которой будет осуществляться фильтрация. Это поля обязательно, когда нет фильтрации по полю date

torequired

string

Дата до которой будет осуществляться фильтрация. Это поля обязательно, когда нет фильтрации по полю date

Response

200

Успешный ответ

JSON
[
                {
                    "type": "analytics_detail",
                    "items": [
                        {
                            "total": 21,
                            "event": {
                                "id": 3,
                                "analytic_type": "face",
                                "name": "unrecognized-face",
                                "description": "Лицо не идентифицировано",
                                "color": "#91D4E2"
                            }
                        },{
                            "total": 9,
                            "event": {
                                "id": 2,
                                "analytic_type": "face",
                                "name": "recognized-face",
                                "description": "Лицо идентифицировано",
                                "color": "#07D4F0"
                            }
                        }
                    ]
                }
            ]
401

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

Пример

JSON
curl -k --location --request GET 'https://vms.local/api/v1/events/dashboard/analytics/detailed?date=string&timezone=string&from=string&to=string' \
--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.