List of events

GET /api/admin/v1/external-events

Method parameters

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

int page, page number for pagination

string sort, field by which the servers should be sorted

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

200 OK

Successful response

JSON

[
    {
        "id": 61,
        "name": "alarm_security_zone",
        "description": "Security zone alarm",
        "color": null,
        "analytic_type": null
    },
    {
        "id": 72,
        "name": "closing_dry_contact",
        "description": "Dry contact closure",
        "color": null,
        "analytic_type": null
    },
    {
        "id": 71,
        "name": "start_firefighting",
        "description": "Fire extinguishing activation",
        "color": null,
        "analytic_type": null
    },
    {
        "id": 70,
        "name": "two_fires",
        "description": "Two fires",
        "color": null,
        "analytic_type": null
    },
    {
        "id": 69,
        "name": "fire_2",
        "description": "Fire 2",
        "color": null,
        "analytic_type": null
    },
    {
        "id": 68,
        "name": "fire",
        "description": "Fire",
        "color": null,
        "analytic_type": null
    },
    {
        "id": 67,
        "name": "access_denied_by_identifier",
        "description": "Access denied by card",
        "color": null,
        "analytic_type": null
    },
    {
        "id": 66,
        "name": "door_not_closed",
        "description": "Attention! Door not closed",
        "color": null,
        "analytic_type": null
    },
    {
        "id": 65,
        "name": "hacked_door",
        "description": "Door tampering",
        "color": null,
        "analytic_type": null
    },
    {
        "id": 64,
        "name": "unknown_identifier",
        "description": "Unknown card identifier",
        "color": null,
        "analytic_type": null
    },
    {
        "id": 63,
        "name": "attention_security_zone",
        "description": "Attention! Alarm in entry zone",
        "color": null,
        "analytic_type": null
    },
    {
        "id": 62,
        "name": "fault_security_system",
        "description": "Security system malfunction",
        "color": null,
        "analytic_type": null
    },
    {
        "id": 60,
        "name": "line-intersection",
        "description": "Line crossing detection",
        "color": "#813A79",
        "analytic_type": "line-intersection"
    },
    {
        "id": 59,
        "name": "smoke-fire",
        "description": "Smoke and fire detection",
        "color": "#FF5A3F",
        "analytic_type": "smoke-fire"
    },
    {
        "id": 58,
        "name": "loud-sound",
        "description": "Detection of loud sounds",
        "color": "#008CFF",
        "analytic_type": "loud-sound"
    },
    {
        "id": 41,
        "name": "person_counting",
        "description": "Queue processing",
        "color": "#FF7CF2",
        "analytic_type": "person_counting"
    },
    {
        "id": 33,
        "name": "camera-obstacle",
        "description": "Camera damage/overlap/vandalism detection",
        "color": "#2542DF",
        "analytic_type": "camera-obstacle"
    },
    {
        "id": 28,
        "name": "motion-detect",
        "description": "Motion detection",
        "color": "#5AD057",
        "analytic_type": "motion-detect"
    },
    {
        "id": 18,
        "name": "recognized-face",
        "description": "Face recognized",
        "color": "#07D4F0",
        "analytic_type": "face"
    },
    {
        "id": 22,
        "name": "pedestrian_detect",
        "description": "models.events.pedestrian_detect",
        "color": "#ff618c",
        "analytic_type": "queue"
    },
    {
        "id": 21,
        "name": "unrecognized-plate-start",
        "description": "Appearance of an unrecognized license plate",
        "color": "#628BFF",
        "analytic_type": "license_plate"
    },
    {
        "id": 20,
        "name": "recognized-plate-start",
        "description": "Appearance of a recognized license plate",
        "color": "#3EDE9B",
        "analytic_type": "license_plate"
    },
    {
        "id": 19,
        "name": "unrecognized-face",
        "description": "Face unrecognized",
        "color": "#91D4E2",
        "analytic_type": "face"
    },
    {
        "id": 27,
        "name": "visitor_counting",
        "description": "Visitor counting",
        "color": "#8B3EBA",
        "analytic_type": "visitor_counting"
    }
]

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/external-events' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "per_page": 0,
    "page": 0,
    "sort": "string",
    "dir": "string"
}'

PHP

$data = array (
  'per_page' => 0,
  'page' => 0,
  'sort' => 'string',
  'dir' => '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/external-events', false, $context);