Skip to main content
Skip table of contents

Список событий. Подсчет посетителей

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

GET/api/v1/analytic-case/{case}/visitors-counting/history

Headers

Authorization

Bearer token

Accept

application/json

X-Client

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

X-UUID

unique device id

Body

caseoptional

int

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

camerarequired

array

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

agerequired

string

Возраст, по которому будет осуществляться фильтрация

sexrequired

string

Пол, по которому будет осуществляться фильтрация

steprequired

string

Фильтрация в рамках одного дня

daterequired

string

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

timezonerequired

string

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

fromrequired

string

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

torequired

string

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

Response

200

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

JSON
{
    "total": 153,
    "bar": {
        "labels": [
            "2022-04-07 07:00",
            "2022-04-07 08:00",
            "2022-04-07 09:00",
            "2022-04-07 10:00",
            "2022-04-07 11:00",
            "2022-04-07 12:00",
            "2022-04-07 13:00",
            "2022-04-07 14:00",
            "2022-04-07 15:00",
            "2022-04-07 16:00"
        ],
        "datasets": [
            {
                "label": "Вход в офис",
                "data": [
                    5,
                    24,
                    28,
                    7,
                    7,
                    10,
                    27,
                    16,
                    17,
                    12
                ],
                "backgroundColor": "#F3D400"
            }
        ]
    },
    "sex": {
        "labels": [
            "Женский",
            "Мужской",
            "Нераспознан"
        ],
        "datasets": [
            {
                "label": "Пол",
                "data": [
                    23,
                    69,
                    61
                ],
                "backgroundColor": [
                    "#FF4E84",
                    "#628BFF",
                    "#86EEFF"
                ]
            }
        ]
    },
    "age": {
        "labels": [
            "До 18 лет",
            "18-30 лет",
            "30-45 лет",
            "45-60 лет",
            "60+ лет",
            "Нераспознан"
        ],
        "datasets": [
            {
                "label": "Возраст",
                "data": [
                    0,
                    10,
                    59,
                    23,
                    0,
                    61
                ],
                "backgroundColor": [
                    "#3B00FF",
                    "#628BFF",
                    "#B4C7FF",
                    "#FF4E84",
                    "#86EEFF",
                    "#6ec8e0"
                ]
            }
        ]
    }
}
401

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

422

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

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

Пример

JSON
curl -k --location --request GET 'https://vms.local/api/v1/analytic-case/{case}/visitor-counting/history?camera=array&age=string&sex=string&step=string&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.