Skip to main content
Skip table of contents

Список всех событий аналитики

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

GET/api/v1/analytic-case/events

Headers

Authorization

Bearer token

Accept

application/json

X-Client

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

X-UUID

unique device id

Body

per_pagerequired

int

Количество элементов в одной странице пагинации. По умолчанию 25 штук

camerasrequired

array

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

fromrequired

string

Дата, от которой будет осуществляться фильтрация

torequired

string

Дата, до которой будет осуществляться фильтрация

eventsrequired

array

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

analytic_typesrequired

array

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

idsrequired

array

Массив id кейсов аналитики, по которым будет осуществляться фильтрация

daterequired

string

Шаблон для фильтрации по дате.

timezonerequired

string

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

dirrequired

string

В каком направлении нужно отсортировать по дате. desc - от большего к меньшему, asc - от меньшего к большему

similarity_fromrequired

int

Процент схожести, от которого будет осуществляться фильтрация

similarity_torequired

int

Процент схожести, до которого будет осуществляться фильтрация

Response

200

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

JSON
{
                "data": [
                    {
                        "type": "face",
                        "crop": "data:image/jpeg;base64",
                        "created_at": "2023-02-07T19:34:14.000000Z",
                        "rect": null,
                        "uuid": "3ac8cd91-b5b3-4fbe-a201-d072bb0e0a01",
                        "similarity": 0,
                        "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": "Название камеры"
                        },
                        "analytic_file": null,
                        "analytic_group": null,
                        "analytic_case": {
                            "id": 2,
                            "title": "asad",
                            "type": "face",
                            "type_pretty": "Распознавание лиц",
                            "status": "active",
                            "created_at": "2023-02-03T10:51:53.000000Z",
                            "updated_at": "2023-01-26T07:56:47.000000Z",
                            "color": "#E5642E",
                            "available_events": [],
                            "is_fails_exists": false
                        },
                        "event": {
                            "id": 5,
                            "name": "unrecognized-face",
                            "description": "Лицо не идентифицировано",
                            "color": "#91D4E2",
                            "analytic_type": "face"
                        }
                    }
                ],
            "links": {
                "first": "http://localhost:8080/api/v1/analytic-case/events?page=1",
                "last": "http://localhost:8080/api/v1/analytic-case/events?page=25",
                "prev": null,
                "next": "http://localhost:8080/api/v1/analytic-case/events?page=2"
            },
            "meta": {
                "current_page": 1,
                "from": 1,
                "last_page": 25,
                "links": [
                        {
                            "url": null,
                            "label": "pagination.previous",
                            "active": false
                        },
                        {
                            "url": "http://localhost:8080/api/v1/analytic-case/events?page=1",
                            "label": "1",
                            "active": true
                        },
                        {
                            "url": "http://localhost:8080/api/v1/analytic-case/events?page=2",
                            "label": "2",
                            "active": false
                        },
                        {
                            "url": "http://localhost:8080/api/v1/analytic-case/events?page=3",
                            "label": "3",
                            "active": false
                        },
                        {
                            "url": null,
                            "label": "...",
                            "active": false
                        },
                        {
                            "url": "http://localhost:8080/api/v1/analytic-case/events?page=24",
                            "label": "24",
                            "active": false
                        },
                        {
                            "url": "http://localhost:8080/api/v1/analytic-case/events?page=25",
                            "label": "25",
                            "active": false
                        },
                        {
                            "url": "http://localhost:8080/api/v1/analytic-case/events?page=2",
                            "label": "pagination.next",
                            "active": false
                        }
                    ],
                "path": "http://localhost:8080/api/v1/analytic-case/events",
                "per_page": 1,
                "to": 1,
                "total": 25
                }
            }
401

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

422

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

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

Пример

JSON
curl -k --location --request GET 'https://vms.local/api/v1/analytic-case/events?per_page=int&cameras=array&from=string&to=string&events=array&analytic_types=array&ids=array&date=string&timezone=string&dir=string&similarity_from=int&similarity_to=int' \
--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.