Skip to main content
Skip table of contents

Executable analytics files

Executable analytics files

GET /api/admin/v1/analytic-binaries

Method parameters

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

int page, pagination page number

string search, search performed by UID, analytics type, and server

string sort, sorting performed by analytics type

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

string binary_type, filtering by executable file type, comes to the Main configurations under the key analytic_cases

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

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

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

200 OK

Successful response

JSON 
{
    "data": [
        {
            "id": 495,
            "binary_type": "visitors-counting",
            "binary_type_pretty": "Visitor counting",
            "status": "RUNNING",
            "server": {
                "id": 2,
                "name": "S1",
                "ip": "192.168.111.2"
            },
            "uid": "73ef0d32-baff-11ec-8995-a3b0e5228375"
        },
        {
            "id": 488,
            "binary_type": "visitors-counting",
            "binary_type_pretty": "Visitor counting",
            "status": "RUNNING",
            "server": {
                "id": 4,
                "name": "S3",
                "ip": "192.168.111.4"
            },
            "uid": "61ef4c6c-a387-11ec-8995-a3b0e5228375"
        },
        {
            "id": 489,
            "binary_type": "visitors-counting",
            "binary_type_pretty": "Visitor counting",
            "status": "RUNNING",
            "server": {
                "id": 3,
                "name": "S2",
                "ip": "192.168.111.3"
            },
            "uid": "a44d9b6c-ab67-11ec-8995-a3b0e5228375"
        },
        {
            "id": 502,
            "binary_type": "smoke-fire",
            "binary_type_pretty": "Smoke and fire detection",
            "status": "RUNNING",
            "server": {
                "id": 2,
                "name": "S1",
                "ip": "192.168.111.2"
            },
            "uid": "30ab6396-c701-11ec-88bc-59d920260ee8"
        },
        {
            "id": 504,
            "binary_type": "smoke-fire",
            "binary_type_pretty": "Smoke and fire detection",
            "status": "RUNNING",
            "server": {
                "id": 4,
                "name": "S3",
                "ip": "192.168.111.4"
            },
            "uid": "14d30290-cd3d-11ec-88bc-59d920260ee8"
        },
        {
            "id": 505,
            "binary_type": "smoke-fire",
            "binary_type_pretty": "Smoke and fire detection",
            "status": "RUNNING",
            "server": {
                "id": 3,
                "name": "S2",
                "ip": "192.168.111.3"
            },
            "uid": "52efe498-cd43-11ec-88bc-59d920260ee8"
        },
        {
            "id": 496,
            "binary_type": "person-counting",
            "binary_type_pretty": "Queue processing",
            "status": "RUNNING",
            "server": {
                "id": 3,
                "name": "S2",
                "ip": "192.168.111.3"
            },
            "uid": "7ae3fdbc-bcb4-11ec-8995-a3b0e5228375"
        },
        {
            "id": 486,
            "binary_type": "person-counting",
            "binary_type_pretty": "Queue processing",
            "status": "RUNNING",
            "server": {
                "id": 2,
                "name": "S1",
                "ip": "192.168.111.2"
            },
            "uid": "ea101d8a-9f7a-11ec-8995-a3b0e5228375"
        },
        {
            "id": 487,
            "binary_type": "person-counting",
            "binary_type_pretty": "Queue processing",
            "status": "RUNNING",
            "server": {
                "id": 4,
                "name": "S3",
                "ip": "192.168.111.4"
            },
            "uid": "ea1d365a-9f7a-11ec-8995-a3b0e5228375"
        },
        {
            "id": 481,
            "binary_type": "motion-detect",
            "binary_type_pretty": "Motion detection",
            "status": "RUNNING",
            "server": {
                "id": 4,
                "name": "S3",
                "ip": "192.168.111.4"
            },
            "uid": "f45d2b96-9adb-11ec-8995-a3b0e5228375"
        },
        {
            "id": 490,
            "binary_type": "motion-detect",
            "binary_type_pretty": "Motion detection",
            "status": "RUNNING",
            "server": {
                "id": 3,
                "name": "S2",
                "ip": "192.168.111.3"
            },
            "uid": "dfd0dab4-ab67-11ec-8995-a3b0e5228375"
        },
        {
            "id": 506,
            "binary_type": "motion-detect",
            "binary_type_pretty": "Motion detection",
            "status": "RUNNING",
            "server": {
                "id": 2,
                "name": "S1",
                "ip": "192.168.111.2"
            },
            "uid": "e74dabbe-d1fa-11ec-88bc-59d920260ee8"
        },
        {
            "id": 503,
            "binary_type": "loud-sounds",
            "binary_type_pretty": "Detection of loud sounds",
            "status": "RUNNING",
            "server": {
                "id": 4,
                "name": "S3",
                "ip": "192.168.111.4"
            },
            "uid": "08e10efa-cd3d-11ec-88bc-59d920260ee8"
        },
        {
            "id": 499,
            "binary_type": "loud-sounds",
            "binary_type_pretty": "Detection of loud sounds",
            "status": "RUNNING",
            "server": {
                "id": 3,
                "name": "S2",
                "ip": "192.168.111.3"
            },
            "uid": "f8e98e40-c6df-11ec-88bc-59d920260ee8"
        },
        {
            "id": 500,
            "binary_type": "loud-sounds",
            "binary_type_pretty": "Detection of loud sounds",
            "status": "RUNNING",
            "server": {
                "id": 2,
                "name": "S1",
                "ip": "192.168.111.2"
            },
            "uid": "fa001560-c6df-11ec-88bc-59d920260ee8"
        },
        {
            "id": 507,
            "binary_type": "line-intersection",
            "binary_type_pretty": "Line crossing detection",
            "status": "RUNNING",
            "server": {
                "id": 4,
                "name": "S3",
                "ip": "192.168.111.4"
            },
            "uid": "41b22714-d512-11ec-88bc-59d920260ee8"
        },
        {
            "id": 508,
            "binary_type": "line-intersection",
            "binary_type_pretty": "Line crossing detection",
            "status": "RUNNING",
            "server": {
                "id": 2,
                "name": "S1",
                "ip": "192.168.111.2"
            },
            "uid": "7a17d19c-d519-11ec-88bc-59d920260ee8"
        },
        {
            "id": 501,
            "binary_type": "line-intersection",
            "binary_type_pretty": "Line crossing detection",
            "status": "RUNNING",
            "server": {
                "id": 3,
                "name": "S2",
                "ip": "192.168.111.3"
            },
            "uid": "a6e862d2-c6ea-11ec-88bc-59d920260ee8"
        },
        {
            "id": 482,
            "binary_type": "licplate-recognition",
            "binary_type_pretty": "License plate recognition",
            "status": "RUNNING",
            "server": {
                "id": 2,
                "name": "S1",
                "ip": "192.168.111.2"
            },
            "uid": "cc72d394-9ae3-11ec-8995-a3b0e5228375"
        },
        {
            "id": 491,
            "binary_type": "licplate-recognition",
            "binary_type_pretty": "License plate recognition",
            "status": "RUNNING",
            "server": {
                "id": 4,
                "name": "S3",
                "ip": "192.168.111.4"
            },
            "uid": "fee82e4e-ac33-11ec-8995-a3b0e5228375"
        },
        {
            "id": 483,
            "binary_type": "licplate-recognition",
            "binary_type_pretty": "License plate recognition",
            "status": "RUNNING",
            "server": {
                "id": 3,
                "name": "S2",
                "ip": "192.168.111.3"
            },
            "uid": "cc7c6b84-9ae3-11ec-8995-a3b0e5228375"
        },
        {
            "id": 492,
            "binary_type": "face-recognition",
            "binary_type_pretty": "Face recognition",
            "status": "RUNNING",
            "server": {
                "id": 2,
                "name": "S1",
                "ip": "192.168.111.2"
            },
            "uid": "0ad632aa-ac34-11ec-8995-a3b0e5228375"
        },
        {
            "id": 485,
            "binary_type": "face-recognition",
            "binary_type_pretty": "Face recognition",
            "status": "RUNNING",
            "server": {
                "id": 3,
                "name": "S2",
                "ip": "192.168.111.3"
            },
            "uid": "d83fd07c-9ae4-11ec-8995-a3b0e5228375"
        },
        {
            "id": 484,
            "binary_type": "face-recognition",
            "binary_type_pretty": "Face recognition",
            "status": "RUNNING",
            "server": {
                "id": 4,
                "name": "S3",
                "ip": "192.168.111.4"
            },
            "uid": "d83756e0-9ae4-11ec-8995-a3b0e5228375"
        },
        {
            "id": 494,
            "binary_type": "camera-obstacle",
            "binary_type_pretty": "Camera damage/overlap/vandalism detection",
            "status": "RUNNING",
            "server": {
                "id": 3,
                "name": "S2",
                "ip": "192.168.111.3"
            },
            "uid": "38604aec-baff-11ec-8995-a3b0e5228375"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=2",
        "prev": null,
        "next": "/?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "/?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "/?page=2",
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 25,
        "to": 25,
        "total": 26
    }
}

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-binaries' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "per_page": 0,
    "page": 0,
    "search": "string",
    "sort": "string",
    "dir": "string",
    "binary_type": "string",
    "status": "string",
    "server_name": "string",
    "binary_uid": "string"
}'
PHP
PHP 
$data = array (
  'per_page' => 0,
  'page' => 0,
  'search' => 'string',
  'sort' => 'string',
  'dir' => 'string',
  'binary_type' => 'string',
  'status' => 'string',
  'server_name' => 'string',
  'binary_uid' => '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-binaries', 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