Skip to main content
Skip table of contents

List of cameras used in the case

List of cameras used in the analytics case. Each camera object contains an «event» field that provides the latest actual count of people in the area.

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

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

camerasrequired

array

Array of camera IDs

daterequired

string

Template for date filtering. This field is mandatory when there is no filtering by «from» and «to» fields

timezonerequired

string

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

fromrequired

string

Start date for filtering. This field is mandatory when there is no filtering by the «date» field

torequired

string

End date for filtering. This field is mandatory when there is no filtering by the «date» field

Response

200

Returns an array of cameras used in the analytics case

JSON
[
    {
        "id": 746,
        "group_id": 98,
        "status": "active",
        "type": "media_server_v2",
        "start_at": "2022-03-23 15:42:07",
        "created_at": "2022-01-27 19:12:36",
        "billing_id": null,
        "pretty_name": "Camera 1",
        "pretty_text": "Cameras",
        "short_address": "Cameras",
        "full_address": "Cameras",
        "lat": null,
        "lng": null,
        "azimuth": null,
        "streams": [
            {
                "id": 735,
                "type": "high",
                "camera_id": 746,
                "is_preview_from_server": true,
                "is_archive_from_server": null,
                "status": "active",
                "has_sound": true,
                "width": 1280,
                "height": 960
            },
            {
                "id": 736,
                "type": "low",
                "camera_id": 746,
                "is_preview_from_server": true,
                "is_archive_from_server": null,
                "status": "active",
                "has_sound": true,
                "width": 1280,
                "height": 960
            }
        ],
        "has_sound": true,
        "archive_ranges": [
            {
                "end": 1648122119,
                "from": 1648039207,
                "duration": 82912
            }
        ],
        "is_archive_recording": true,
        "meta": {
            "line": [],
            "figure": [
                {
                    "x": 0.10390625,
                    "y": 0.18125
                },
                {
                    "x": 0.81953126,
                    "y": 0.8979167
                },
                {
                    "x": 0.87890625,
                    "y": 0.45833334
                },
                {
                    "x": 0.7445313,
                    "y": 0.19375
                },
                {
                    "x": 0.39609376,
                    "y": 0.18958333
                },
                {
                    "x": 0.10390625,
                    "y": 0.18125
                },
                {
                    "x": 0.81953126,
                    "y": 0.8979167
                },
                {
                    "x": 0.87890625,
                    "y": 0.45833334
                },
                {
                    "x": 0.7445313,
                    "y": 0.19375
                },
                {
                    "x": 0.39609376,
                    "y": 0.18958333
                }
            ],
            "threshold": 3
        },
        "is_bridge": false,
        "is_favorite": false,
        "user_status": "active",
        "name": "Camera 1"
    }
]
401

Authorization token 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}/person-counting/live?cameras=array&date=string&timezone=string&from=string&to=string' \
--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.