Create an analytics case. Counting people in the area

Creating an analytics case with the type "Counting people in the area".

This analytics case involves automatic localization and precise counting of people within a designated area of a video stream. It can be applied in various use cases where there is a need for continuous monitoring of the number of people in specific areas/locations, with notification alerts based on predefined thresholds.

Event: Detection and counting of the number of objects (people) within the detection zone of the selected camera.

POST/api/v1/analytic-case

Headers
Authorization		Bearer token
Accept		application/json
X-Client		ios-cctv\|android-cctv\|thick-legal\|web
X-UUID		unique device id

Body
json	JSON { "title": "Counting people in the area", "type": "person_counting", "cameras": [ { "id": 10, "analytic_case_camera_user_status": null, "scripts": [ { "id": 20 } ], "meta": { "figure": [ { "x": 0.1484375, "y": 0.2222222222222222 }, { "x": 0.3453125, "y": 0.7722222222222223 }, { "x": 0.840625, "y": 0.625 }, { "x": 0.79375, "y": 0.1527777777777778 } ], "reaction_after_value": 3 } }, { "id": 7, "analytic_case_camera_user_status": null, "scripts": [ { "id": 20 } ], "meta": { "figure": [ { "x": 0.1625, "y": 0.3194444444444444 }, { "x": 0.4203125, "y": 0.925 }, { "x": 0.9390625, "y": 0.7222222222222222 }, { "x": 0.7734375, "y": 0.1527777777777778 } ], "reaction_after_value": 3 } } ] }
title^required	string	Analytics case name
type^required	string	For this type of case, always provide the value «person_counting».
cameras^required	array	Array of camera objects specifying the event and reaction
*cameras..id^required**	array	Camera ID
*cameras..scripts^required**	array	Array of event and reaction IDs
*cameras..scripts..id^required*	int	Event and reaction IDs, see Creating an event and reaction
*cameras..meta.figure^required**	array	Designated area within the camera's view that will be processed by the analytics. It is passed as an array of coordinates (bend points of a line) relative to values ranging from 0 to 1. The number of points can range from three to "n." The last coordinate should not be included, as the area will be closed with the initial coordinate

Response
201		Returns the analytics case
JSON { "id": 42, "title": "Counting people in the area", "type": "person_counting", "type_pretty": "Counting people in the area", "status": "active", "cameras": [ { "id": 10, "group_id": 2, "status": "active", "type": "media_server_v2", "start_at": "", "created_at": "2022-12-16 10:25:55", "billing_id": null, "pretty_name": "Camera 1", "pretty_text": "Cameras", "short_address": "Cameras", "full_address": "Cameras", "lat": null, "lng": null, "azimuth": null, "streams": [ { "id": 19, "type": "high", "camera_id": 10, "is_preview_from_server": true, "is_archive_from_server": null, "status": "active", "has_sound": false, "width": null, "height": null }, { "id": 20, "type": "low", "camera_id": 10, "is_preview_from_server": true, "is_archive_from_server": null, "status": "active", "has_sound": false, "width": null, "height": null } ], "has_sound": false, "archive_ranges": [], "archive_recording_timetable": null, "is_archive_recording": false, "archive_recording_type": "fulltime", "can_change_archive_timetable": false, "scripts": [ { "id": 20, "title": "Set a label", "schedule": [], "timetable": { "days": [ { "to": "23:59:00+05:00", "from": "00:00:00+05:00", "type": "same_every_day", "breaks": [] } ], "intervals": [] }, "status": "active", "created_at": "2022-12-21 12:41:39", "updated_at": "2022-12-21 12:41:39", "users": [ { "id": 5, "login": "user", "name": "user", "parent_id": null, "created_at": "2022-12-06 20:20:58", "updated_at": "2022-12-21 10:53:45", "access_token_id": null, "can_update_password": true } ], "event": { "id": 3, "name": "person_counting", "description": "Counting people in the area", "color": "#FF7CF2", "analytic_type": "person_counting" }, "extra": null } ], "meta": { "figure": [ { "x": 0.1484375, "y": 0.2222222222222222 }, { "x": 0.3453125, "y": 0.7722222222222223 }, { "x": 0.840625, "y": 0.625 }, { "x": 0.79375, "y": 0.1527777777777778 } ], "reaction_after_value": 3 }, "analytic_case_camera_status": "inactive", "analytic_case_camera_status_pretty": "Camera inactive", "analytic_case_camera_user_status": "failed_to_create", "analytic_case_camera_user_status_pretty": "Creation error", "event": null, "is_bridge": false, "is_favorite": false, "user_status": "active", "name": "Camera 1" }, { "id": 7, "group_id": 2, "status": "inactive", "type": "media_server_v2", "start_at": "", "created_at": "2022-12-16 10:25:54", "billing_id": null, "pretty_name": "Camera 2", "pretty_text": "Cameras", "short_address": "Cameras", "full_address": "Cameras", "lat": null, "lng": null, "azimuth": null, "streams": [ { "id": 13, "type": "high", "camera_id": 7, "is_preview_from_server": true, "is_archive_from_server": null, "status": "active", "has_sound": false, "width": null, "height": null }, { "id": 14, "type": "low", "camera_id": 7, "is_preview_from_server": true, "is_archive_from_server": null, "status": "active", "has_sound": false, "width": null, "height": null } ], "has_sound": false, "archive_ranges": [], "archive_recording_timetable": null, "is_archive_recording": false, "archive_recording_type": "fulltime", "can_change_archive_timetable": false, "scripts": [ { "id": 20, "title": "Set a label", "schedule": [], "timetable": { "days": [ { "to": "23:59:00+05:00", "from": "00:00:00+05:00", "type": "same_every_day", "breaks": [] } ], "intervals": [] }, "status": "active", "created_at": "2022-12-21 12:41:39", "updated_at": "2022-12-21 12:41:39", "users": [ { "id": 5, "login": "user", "name": "user", "parent_id": null, "created_at": "2022-12-06 20:20:58", "updated_at": "2022-12-21 10:53:45", "access_token_id": null, "can_update_password": true } ], "event": { "id": 3, "name": "person_counting", "description": "Counting people in the area", "color": "#FF7CF2", "analytic_type": "person_counting" }, "extra": null } ], "meta": { "figure": [ { "x": 0.1625, "y": 0.3194444444444444 }, { "x": 0.4203125, "y": 0.925 }, { "x": 0.9390625, "y": 0.7222222222222222 }, { "x": 0.7734375, "y": 0.1527777777777778 } ], "reaction_after_value": 3 }, "analytic_case_camera_status": "active", "analytic_case_camera_status_pretty": "Camera active", "analytic_case_camera_user_status": null, "analytic_case_camera_user_status_pretty": null, "event": null, "is_bridge": false, "is_favorite": false, "user_status": "active", "name": "Camera 2" } ], "created_at": "2022-12-21 12:41:54", "updated_at": "2022-12-21 12:41:54", "color": "#F027DC", "available_events": [], "is_fails_exists": true, "errors": [ "Error creating camera Camera 1." ] }
401		Authorization token not provided or invalid, see Obtaining a token
402		License limit exceeded for the selected analytics case
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 POST 'https://vms.local/api/v1/analytic-case' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id' \
--header 'Content-Type: application/json \
--data-raw '{
    "title": "Counting people in the area",
    "type": "person_counting",
    "cameras": [
        {
            "id": 10,
            "analytic_case_camera_user_status": null,
            "scripts": [
                {
                    "id": 20
                }
            ],
            "meta": {
                "figure": [
                    {
                        "x": 0.1484375,
                        "y": 0.2222222222222222
                    },
                    {
                        "x": 0.3453125,
                        "y": 0.7722222222222223
                    },
                    {
                        "x": 0.840625,
                        "y": 0.625
                    },
                    {
                        "x": 0.79375,
                        "y": 0.1527777777777778
                    }
                ],
                "reaction_after_value": 3
            }
        },
        {
            "id": 7,
            "analytic_case_camera_user_status": null,
            "scripts": [
                {
                    "id": 20
                }
            ],
            "meta": {
                "figure": [
                    {
                        "x": 0.1625,
                        "y": 0.3194444444444444
                    },
                    {
                        "x": 0.4203125,
                        "y": 0.925
                    },
                    {
                        "x": 0.9390625,
                        "y": 0.7222222222222222
                    },
                    {
                        "x": 0.7734375,
                        "y": 0.1527777777777778
                    }
                ],
                "reaction_after_value": 3
            }
        }
    ]
}'