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

График событий подсчета людей в области

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

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

Параметры метода

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

str chart, line - line график

bar - bar график

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

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

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

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

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

200 OK

Возвращает список данных для построения 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 OK

Возвращает список данных для построения 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 Unauthorized

Токен авторизации не передан или не валидный

422 Unprocessable Entity

Возвращает JSON объект с ошибкой. VMS Client/Общая информация/Валидация клиента

JSON

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

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/v1/analytic-case/{case}/person-counting/chart' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "case": 0,
    "chart": "str",
    "date": "string",
    "cameras": [],
    "timezone": "string",
    "from": "string",
    "to": "string"
}'

PHP

$data = array (
  'case' => 0,
  'chart' => 'str',
  'date' => 'string',
  'cameras' => 
  array (
  ),
  'timezone' => 'string',
  'from' => 'string',
  'to' => 'string',
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/v1/analytic-case/{case}/person-counting/chart', false, $context);