Skip to main content
Skip table of contents

Get the list of analytics stream settings (ovms)

Get the list of analytics stream settings (ovms)

GET /api/admin/v1/analytic/ovms/streams/{stream}/settings

Parameters

string stream, The job_uid identifier

200 OK

Successful response

JSON
{
    "settings": [
        {
            "key": "fps",
            "default_value": 10,
            "format": "integer",
            "max": null,
            "min": null,
            "value": "21"
        },
        {
            "key": "min_obj_size",
            "default_value": 30,
            "format": "float",
            "max": null,
            "min": 0,
            "value": "50.5"
        },
        {
            "key": "min_obj_rel_width",
            "default_value": 0,
            "format": "float",
            "max": 1,
            "min": 0,
            "value": null
        },
        {
            "key": "min_obj_rel_height",
            "default_value": 0,
            "format": "float",
            "max": 1,
            "min": 0,
            "value": null
        },
        {
            "key": "motion_min_scale",
            "default_value": 2,
            "format": "integer",
            "max": null,
            "min": 1,
            "value": null
        },
        {
            "key": "motion_cooldown",
            "default_value": 0.5,
            "format": "float",
            "max": null,
            "min": 0,
            "value": null
        },
        {
            "key": "weak_obj_score_threshold",
            "default_value": 0.8,
            "format": "float",
            "max": 1,
            "min": 0,
            "value": null
        },
        {
            "key": "strong_obj_score_threshold",
            "default_value": 0.95,
            "format": "float",
            "max": 1,
            "min": 0,
            "value": null
        },
        {
            "key": "glance_expansion",
            "default_value": 3.5,
            "format": "float",
            "max": null,
            "min": 1,
            "value": null
        },
        {
            "key": "aggregation_time",
            "default_value": 0.5,
            "format": "float",
            "max": null,
            "min": 0,
            "value": null
        },
        {
            "key": "similarity_threshold",
            "default_value": 0.25,
            "format": "float",
            "max": 1,
            "min": 0,
            "value": null
        },
        {
            "key": "low_quality_threshold",
            "default_value": 0.3,
            "format": "float",
            "max": 1,
            "min": 0,
            "value": null
        },
        {
            "key": "track_lifetime",
            "default_value": 2,
            "format": "float",
            "max": null,
            "min": 0,
            "value": null
        },
        {
            "key": "tracking_similarity_threshold",
            "default_value": 0.7,
            "format": "float",
            "max": 1,
            "min": 0,
            "value": null
        },
        {
            "key": "recognized_face_persistency",
            "default_value": 10,
            "format": "float",
            "max": null,
            "min": 0,
            "value": null
        },
        {
            "key": "recognized_face_report_interval",
            "default_value": 30,
            "format": "float",
            "max": null,
            "min": null,
            "value": null
        },
        {
            "key": "tracked_objects_limit",
            "default_value": 32,
            "format": "integer",
            "max": null,
            "min": 0,
            "value": null
        }
    ],
    "analytics_type": "face-recognition",
    "analytics_type_pretty": "Face Recognition"
}

401 Unauthorized

Authorization token not sent or not valid

cURL
BASH
curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/analytic/ovms/streams/{stream}/settings' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "stream": "string"
}'
PHP
PHP
$data = array (
  'stream' => 'string',
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/admin/v1/analytic/ovms/streams/{stream}/settings', false, $context);
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.