Skip to main content
Skip table of contents

Statistics. VMS Client API

Statistics on the usage of analytics licenses.

GET/api/v1/analytic-licenses
Headers
Authorization
Bearer token
Accept
application/json
X-Client
ios-cctv|android-cctv|thick-legal|web
X-UUID
unique device id
Response
200
Returns statistics on the usage of analytics cases
JSON
{
    "data": [
        {
            "type": "analytic_l1",
            "type_pretty": "LIC-XXXX-YY-L1",
            "all": 100,
            "free": 95,
            "used": 5
        },
        {
            "type": "analytic_l2",
            "type_pretty": "LIC-XXXX-YY-L2",
            "all": 100,
            "free": 95,
            "used": 5
        },
        {
            "type": "analytic_l3",
            "type_pretty": "LIC-XXXX-YY-L3",
            "all": 100,
            "free": 83,
            "used": 17
        }
    ],
    "used_cases": {
        "analytic_l1": [
            {
                "type": "camera-obstacle",
                "count": 2,
                "subusers": [
                    {
                        "id": 1,
                        "name": "User name",
                        "case_count": 1,
                        "case_type": "case_type"
                    }
                ],
                "type_pretty": "Camera damage / overlap / vandalism detection",
                "color": "#566197"
            },
            {
                "type": "motion_detect",
                "count": 3,
                "subusers": null,
                "type_pretty": "Motion detection",
                "color": "#2CA329"
            }
        ],
        "analytic_l2": [
            {
                "type": "visitor_counting",
                "count": 2,
                "subusers": null,
                "type_pretty": "Visitor counting",
                "color": "#C76DFF"
            },
            {
                "type": "person_counting",
                "count": 3,
                "subusers": null,
                "type_pretty": "Counting people in the area",
                "color": "#F027DC"
            }
        ],
        "analytic_l3": [
            {
                "type": "license_plate",
                "count": 12,
                "subusers": [
                    {
                        "id": 1,
                        "name": "User name",
                        "case_count": 11,
                        "case_type": "license_plate"
                    }
                ],
                "type_pretty": "License plate recognition",
                "color": "#00B2FF"
            },
            {
                "type": "face",
                "count": 5,
                "subusers": [
                    {
                        "id": 1,
                        "name": "User name",
                        "case_count": 2,
                        "case_type": "face"
                    }
                ],
                "type_pretty": "Face recognition",
                "color": "#E5642E"
            }
        ]
    }
}
401
Authorization token not provided or invalid, see Obtaining a token

Example

JSON
curl -k --location --request GET 'https://vms.local/api/v1/analytic-licenses' \
--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.