Skip to main content
Skip table of contents

List of events. License plate recognition

Viewing the list of license plate recognition events.

GET/api/v1/analytic-case/{case}/license-plate/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

Unique identifier of the analytics case

per_pagerequired

int

Number of items per pagination page. Default is 25

camerasrequired

array

Array of camera IDs to display events for

filesrequired

array

Array of resource IDs owned by the user to display events for

groupsrequired

array

Array of resource group IDs owned by the user to display events for

daterequired

string

Template for filtering by date. This field is required when there is no filtering by 'from' and 'to' fields

timezonerequired

string

Timezone for date filtering template. Example - Europe/Paris. This field is required when filtering by date

fromrequired

string

Date for filtering events from. This field is required when there is no filtering by the 'date' field

torequired

string

Date for filtering events until. This field is required when there is no filtering by the 'date' field

eventsrequired

array

Array of event IDs for filtering

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 a list of analytics events on page i of pagination

JSON
{
    "data": [
        {
            "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 10:33:15",
                "created_at": "2022-01-27 19:13:18",
                "billing_id": null,
                "pretty_name": "Camera 1",
                "lat": null,
                "lng": null,
                "azimuth": null,
                "streams": [
                    {
                        "id": 737,
                        "type": "high",
                        "camera_id": 747,
                        "is_preview_from_server": true,
                        "is_archive_from_server": null,
                        "status": "active",
                        "has_sound": false,
                        "width": 1280,
                        "height": 960
                    },
                    {
                        "id": 738,
                        "type": "low",
                        "camera_id": 747,
                        "is_preview_from_server": true,
                        "is_archive_from_server": null,
                        "status": "active",
                        "has_sound": false,
                        "width": 1280,
                        "height": 960
                    }
                ],
                "has_sound": false,
                "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": "name.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",
            "is_can_open": true
        }
    ],
    "links": {
        "first": "https://vms.local/api/v1/analytic-case/945/face/history?per_page=24&page=1",
        "last": "https://vms.local/api/v1/analytic-case/945/face/history?per_page=24&page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "https://vms.local/api/v1/analytic-case/945/face/history?per_page=24&page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local/api/v1/analytic-case/945/face/history",
        "per_page": 24,
        "to": 1,
        "total": 1
    }
}
401

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

422

Returns a JSON object with an error, 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?per_page=int&cameras=array&files=array&groups=array&date=string&timezone=string&from=string&to=string&events=array&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.