Skip to main content
Skip table of contents

График событий

Просмотр списка событий подсчета людей в области.

Респонс будет отдаваться в зависимости от типа графика, который хотят получить.

GET/api/v1/analytic-case/{case}/person-counting/chart

Headers

Authorization

Bearer token

Accept

application/json

X-Client

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

X-UUID

unique device id

Body

case

int

Уникальный идентификатор кейса аналитики

chart

str

line - line график

bar - bar график

date

int

Дата, за которую хотят получить историю

cameras

array

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

date

string

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

timezonerequired

string

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

fromrequired

string

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

torequired

string

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

Response

200

Возвращает список данных для построения line графика

JSON
{
    "labels": [
        "2022-04-07 10:00",
        "2022-04-07 10:30",
        "2022-04-07 12:40",
        "2022-04-07 13:00",
        "2022-04-07 14:10",
        "2022-04-07 14:20"
    ],
    "datasets": [
        {
            "label":"min",
            "data":[1,1,1,1,1,1]
        },
        {
            "label":"average",
            "data":[1,1,1,1,1,1]
        },
        {
            "label":"max",
            "data":[1,1,1,1,1,1]
        }
    ]
}
200

Возвращает список данных для построения bar графика

JSON
{
    "labels": [
        "2022-04-06 14:00",
        "2022-04-06 16:00",
        "2022-04-06 17:00",
        "2022-04-06 18:00",
        "2022-04-06 20:00",
        "2022-04-07 10:00",
        "2022-04-07 12:00",
        "2022-04-07 13:00",
        "2022-04-07 14:00"
    ],
    "datasets": [
        {
            "label":"Кухня",
            "data":[1,1,1,1,1,1,1,1,1],
            "backgroundColor":"#647483"
        }
    ]
}
401

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

422

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

JSON
{
    "message": "Тут не будет информативного сообщения",
    "errors": {
        "any_key": [
            "Тут будет описана причина ошибки"
        ]
    }
}

Пример

JSON
curl -k --location --request GET 'https://vms.local/api/v1/analytic-case/{case}/person-counting/live?cameras=array&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.