Skip to main content
Skip table of contents

Analytics streams (ovms)

Analytics streams (ovms)

GET /api/admin/v1/analytic/ovms/streams

Parameters

int per_page, Number of elements in one pagination page.

int page, Pagination page number

string search, Search is carried out by stream UID, Job uid, executable file UID, server

string sort, Sorting is carried out by the status of the analytics stream

string dir, In which direction to sort.

string status, Filtering by executable file status, comes under the analytic_case_camera_statuses key

string ovms_uid, Filtering by UID of executable files, separate request [VMS Admin/Administrator Analytics/List of uuids of executable analytics files](../available_binaries_uuid.md)

string analytic_type, Filter by analytics type

200 OK

Successful response

JSON 
{
    "data": [
        {
            "ovms_client_id": "62c46f9a-6e5c-11ee-8c4f-b5c3d514a8ed",
            "ovms_client_uid": "62c46f9a-6e5c-11ee-8c4f-b5c3d514a8ed",
            "job_uid": "ba92928c-68e5-11ee-8c4f-b5c3d514a8ed",
            "stream_uid": "382de89c-2b66-438a-a27f-ea8afcc46a05",
            "camera_group_uid": "680c7cd8-7979-490b-a83e-35021171f18e",
            "camera": null,
            "server": null,
            "analytics_type": "licplate-recognition",
            "analytics_type_pretty": "License plate recognition",
            "status": "WORKING",
            "platform_stream_status": null,
            "analytic_case_camera_id": null,
            "is_can_restart": null
        },
        {
            "ovms_client_id": "62c46f9a-6e5c-11ee-8c4f-b5c3d514a8ed",
            "ovms_client_uid": "62c46f9a-6e5c-11ee-8c4f-b5c3d514a8ed",
            "job_uid": "a58f3eac-68e6-11ee-8c4f-b5c3d514a8ed",
            "stream_uid": "382de89c-2b66-438a-a27f-ea8afcc46a05",
            "camera_group_uid": "f13efaae-84c6-4e2c-b255-c2b799761043",
            "camera": null,
            "server": null,
            "analytics_type": "licplate-recognition",
            "analytics_type_pretty": "License plate recognition",
            "status": "WORKING",
            "platform_stream_status": null,
            "analytic_case_camera_id": null,
            "is_can_restart": null
        },
        {
            "ovms_client_id": "62c46f9a-6e5c-11ee-8c4f-b5c3d514a8ed",
            "ovms_client_uid": "62c46f9a-6e5c-11ee-8c4f-b5c3d514a8ed",
            "job_uid": "1e86595a-6908-11ee-8c4f-b5c3d514a8ed",
            "stream_uid": "382de89c-2b66-438a-a27f-ea8afcc46a05",
            "camera_group_uid": "f5135663-cedc-4e75-b5bd-51fb58a315ba",
            "camera": null,
            "server": null,
            "analytics_type": "licplate-recognition",
            "analytics_type_pretty": "License plate recognition",
            "status": "WORKING",
            "platform_stream_status": null,
            "analytic_case_camera_id": null,
            "is_can_restart": null
        },
        {
            "ovms_client_id": "62c46f9a-6e5c-11ee-8c4f-b5c3d514a8ed",
            "ovms_client_uid": "62c46f9a-6e5c-11ee-8c4f-b5c3d514a8ed",
            "job_uid": "7871dc96-6908-11ee-8c4f-b5c3d514a8ed",
            "stream_uid": "382de89c-2b66-438a-a27f-ea8afcc46a05",
            "camera_group_uid": "47c9337c-6702-4314-b372-8f1494cbc8f7",
            "camera": null,
            "server": null,
            "analytics_type": "licplate-recognition",
            "analytics_type_pretty": "License plate recognition",
            "status": "WORKING",
            "platform_stream_status": null,
            "analytic_case_camera_id": null,
            "is_can_restart": null
        },
        {
            "ovms_client_id": "62c46f9a-6e5c-11ee-8c4f-b5c3d514a8ed",
            "ovms_client_uid": "62c46f9a-6e5c-11ee-8c4f-b5c3d514a8ed",
            "job_uid": "83613db8-690d-11ee-8c4f-b5c3d514a8ed",
            "stream_uid": "382de89c-2b66-438a-a27f-ea8afcc46a05",
            "camera_group_uid": "268886b2-c5ae-4a3b-ba65-aec971c2e8f9",
            "camera": null,
            "server": null,
            "analytics_type": "licplate-recognition",
            "analytics_type_pretty": "License plate recognition",
            "status": "WORKING",
            "platform_stream_status": null,
            "analytic_case_camera_id": null,
            "is_can_restart": null
        },
        {
            "ovms_client_id": "62c46f9a-6e5c-11ee-8c4f-b5c3d514a8ed",
            "ovms_client_uid": "62c46f9a-6e5c-11ee-8c4f-b5c3d514a8ed",
            "job_uid": "e125841a-69a6-11ee-8c4f-b5c3d514a8ed",
            "stream_uid": "382de89c-2b66-438a-a27f-ea8afcc46a05",
            "camera_group_uid": "2924e7ab-0b3c-44c7-8e26-ffa4a85461ab",
            "camera": null,
            "server": null,
            "analytics_type": "licplate-recognition",
            "analytics_type_pretty": "License plate recognition",
            "status": "WORKING",
            "platform_stream_status": null,
            "analytic_case_camera_id": null,
            "is_can_restart": null
        },
        {
            "ovms_client_id": "62c46f9a-6e5c-11ee-8c4f-b5c3d514a8ed",
            "ovms_client_uid": "62c46f9a-6e5c-11ee-8c4f-b5c3d514a8ed",
            "job_uid": "7bb91dfe-69be-11ee-8c4f-b5c3d514a8ed",
            "stream_uid": "382de89c-2b66-438a-a27f-ea8afcc46a05",
            "camera_group_uid": "22b3c04f-28cf-48b2-966e-f037e976198f",
            "camera": null,
            "server": null,
            "analytics_type": "licplate-recognition",
            "analytics_type_pretty": "License plate recognition",
            "status": "WORKING",
            "platform_stream_status": null,
            "analytic_case_camera_id": null,
            "is_can_restart": null
        },
        {
            "ovms_client_id": "62c46f9a-6e5c-11ee-8c4f-b5c3d514a8ed",
            "ovms_client_uid": "62c46f9a-6e5c-11ee-8c4f-b5c3d514a8ed",
            "job_uid": "0de5e598-69c1-11ee-8c4f-b5c3d514a8ed",
            "stream_uid": "382de89c-2b66-438a-a27f-ea8afcc46a05",
            "camera_group_uid": "c03a8d73-1ce8-4e2a-af2d-1033293e139e",
            "camera": null,
            "server": null,
            "analytics_type": "licplate-recognition",
            "analytics_type_pretty": "License plate recognition",
            "status": "WORKING",
            "platform_stream_status": null,
            "analytic_case_camera_id": null,
            "is_can_restart": null
        },
        {
            "ovms_client_id": "73c16ae6-6e5c-11ee-8c4f-b5c3d514a8ed",
            "ovms_client_uid": "73c16ae6-6e5c-11ee-8c4f-b5c3d514a8ed",
            "job_uid": "cc1a7bce-6907-11ee-8c4f-b5c3d514a8ed",
            "stream_uid": "382de89c-2b66-438a-a27f-ea8afcc46a05",
            "camera_group_uid": "d2ceabdc-bf73-4b35-afe9-d49fa5c9852d",
            "camera": null,
            "server": null,
            "analytics_type": "licplate-recognition",
            "analytics_type_pretty": "License plate recognition",
            "status": "WORKING",
            "platform_stream_status": null,
            "analytic_case_camera_id": null,
            "is_can_restart": null
        },
        {
            "ovms_client_id": "73c16ae6-6e5c-11ee-8c4f-b5c3d514a8ed",
            "ovms_client_uid": "73c16ae6-6e5c-11ee-8c4f-b5c3d514a8ed",
            "job_uid": "5ff857ee-6908-11ee-8c4f-b5c3d514a8ed",
            "stream_uid": "382de89c-2b66-438a-a27f-ea8afcc46a05",
            "camera_group_uid": "c285f5eb-650a-44e4-b738-f629d2f7ec2b",
            "camera": null,
            "server": null,
            "analytics_type": "licplate-recognition",
            "analytics_type_pretty": "License plate recognition",
            "status": "WORKING",
            "platform_stream_status": null,
            "analytic_case_camera_id": 6,
            "is_can_restart": false
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 25,
        "to": 8,
        "total": 8
    }
}

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' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "per_page": 0,
    "page": 0,
    "search": "string",
    "sort": "string",
    "dir": "string",
    "status": "string",
    "ovms_uid": "string",
    "analytic_type": "string"
}'
PHP
PHP 
$data = array (
  'per_page' => 0,
  'page' => 0,
  'search' => 'string',
  'sort' => 'string',
  'dir' => 'string',
  'status' => 'string',
  'ovms_uid' => 'string',
  'analytic_type' => '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', false, $context);
JavaScript errors detected

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

If this problem persists, please contact our support.

Contact Support Close