Analytics streams

GET /api/admin/v1/analytic-streams

Method parameters

int per_page, number of items per pagination page. Default is 25

int page, pagination page number

string search, search performed by stream UID, Job uid, UID of the executable file, server

string sort, sorting performed by status of the analytics stream

string dir, sorting direction. desc - from highest to lowest, asc - from lowest to highest

string status, filtering by executable file status, comes to the Main configurations under the key analytic_case_camera_statuses

string binary_uid, filtering by executable file UID, separate request for the List of uuid executable analytics files

string server_name, filtering by server name, separate request for the List of analytics server names

200 OK

Successful response

JSON

{
    "data": [
        {
            "job_uid": "752bad60-48ab-11ed-8c49-bd223ebfa82e",
            "status": "WORKING",
            "binary_type_pretty": "models.analytic_cases.title.person_counting",
            "stream_uid": "7f524698-eccc-49b7-b347-ed6932d5a5d1",
            "platform_stream_status": null,
            "camera_group_uid": "cc126bad-a4c5-4687-ba1d-5f01dee84f04",
            "binary_id": 534,
            "binary_type": "person-counting",
            "camera": null,
            "is_can_restart": null,
            "analytic_case_camera_id": null,
            "server": {
                "id": 2,
                "name": "S1",
                "ip": "192.168.111.2"
            },
            "binary_uid": "ecca86e0-486d-11ed-8c49-bd223ebfa82e"
        },
        {
            "job_uid": "ef11279d-486d-11ed-8c49-bd223ebfa82e",
            "status": "UNPAUSE",
            "binary_type_pretty": "models.analytic_cases.title.camera-obstacle",
            "stream_uid": "f4cf9042-6af2-49fc-a7bd-95f1b923e42a",
            "platform_stream_status": null,
            "camera_group_uid": "c7ad06eb-5010-4651-9675-e1dae22934f1",
            "binary_id": 533,
            "binary_type": "camera-obstacle",
            "camera": null,
            "is_can_restart": null,
            "analytic_case_camera_id": null,
            "server": {
                "id": 2,
                "name": "S1",
                "ip": "192.168.111.2"
            },
            "binary_uid": "ec6ac75a-486d-11ed-8c49-bd223ebfa82e"
        }
    ],
    "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": 2,
        "total": 2
    }
}

401 Unauthorized

Authorization token is not provided or is invalid. Obtaining a token

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/analytic-streams' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "per_page": 0,
    "page": 0,
    "search": "string",
    "sort": "string",
    "dir": "string",
    "status": "string",
    "binary_uid": "string",
    "server_name": "string"
}'

PHP

$data = array (
  'per_page' => 0,
  'page' => 0,
  'search' => 'string',
  'sort' => 'string',
  'dir' => 'string',
  'status' => 'string',
  'binary_uid' => 'string',
  'server_name' => '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-streams', false, $context);