Skip to main content
Skip table of contents

List of events by analytics event. License plate recognition

List of events for an analytics event. If there have been n number of faces recognized in the camera's coverage area/zone during the analytics trigger, you can check the presence of the n-th number of events using the «is_can_open» key in the event object, see List of events

GET/api/v1/analytic-case/{case}/license-plate/history/{uuid}

Headers

Authorization

Bearer token

Accept

application/json

X-Client

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

X-UUID

unique device id

Body

caseoptional

int

Unique identifier of the analytics case

uuidoptional

str

Unique identifier of the analytics event

license_platerequired

str

Search by license plate number

similarity_fromrequired

int

Minimum similarity percentage for filtering

similarity_torequired

int

Maximum similarity percentage for filtering

Response

200

Returns an array of analytics events

JSON
[
    {
        "crop": [
            ""
        ],
        "created_at": "2022-04-06 17:30:02",
        "rect": [
            [
                744,
                108,
                40,
                51
            ]
        ],
        "camera": {
            "id": 747,
            "group_id": 98,
            "status": "active",
            "type": "media_server_v2",
            "start_at": "2022-03-23 11:48:17",
            "created_at": "2022-01-27 19:13:18",
            "billing_id": null,
            "pretty_name": "Camera 1",
            "lat": null,
            "lng": null,
            "azimuth": null,
            "is_archive_recording": true,
            "is_bridge": false,
            "is_favorite": false,
            "user_status": "active",
            "name": "Camera 1"
        },
        "analytic_group": {
            "id": 14,
            "name": "1",
            "type": "face_resource",
            "type_pretty": "License plate",
            "uuid": "2d951b2e-a92a-11ec-8995-a3b0e5228375",
            "created_at": "2022-03-21 18:18:36",
            "updated_at": "2022-03-21 18:18:36"
        },
        "analytic_file": {
            "id": 53,
            "name": "1.jpeg",
            "type": "face_resource",
            "type_pretty": "License plate",
            "uuid": null,
            "body": "",
            "url": "https://vms.local/storage/analytic-files/2022/3/21/WMUZQieuxkC1zm4XHVpTwRO3rd2ais1JLcMqzWJt.jpg",
            "created_at": "2022-03-21 18:18:33",
            "updated_at": "2022-03-21 18:18:33"
        },
        "similarity": 11,
        "event": {
            "id": 18,
            "name": "recognized-face",
            "description": "License plate identified",
            "color": "#07D4F0",
            "analytic_type": "face"
        },
        "uuid": "e46844c5-24b1-433e-9031-e69b5f87a8b1"
    }
]
401

Authorization token is not provided or invalid, see Obtaining a token

422

Returns a JSON error object, see Validation

JSON
{
    "message": "There won't be any informative message here",
    "errors": {
        "any_key": [
            "Here the error cause will be described"
        ]
    }
}

Example

JSON
curl -k --location --request GET 'https://vms.local/api/v1/analytic-case/{case}/license-plate/history/{uuid}?license_plate=str&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.