Report on system events

System events report

After receiving a successful response, a push comes with the 'generate_report' type with a link to download the report

POST /api/admin/v1/reports?type=events

array cameras, Filtering by cameras, array of cameras ids (used for filtering events that relate to group system_camera_events)

array event_groups, Groups of system events. A list of possible groups can be found in [VMS Admin/Settings/General administrator configurations](../settings/static.md) in key report.settings.events.event_groups

array event_types, Types of events from the group. The list of possible events for a group is taken from the request

date from, Start date

date to, End date

string timezone, Time zone to display the creation date in the report.

201 Created

Successful response

JSON

{
    "id": 6438,
    "name": "report_1",
    "type": "intercoms",
    "from": "2023-05-24",
    "to": "2023-05-24",
    "url": "https://vms.local:8080/storage/",
    "created_at": "2023-03-09T13:15:35.000000Z"
}

401 Unauthorized

Authorization token not sent or not valid

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/reports?type=events' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "cameras": [],
    "event_groups": [],
    "event_types": [],
    "from": "date",
    "to": "date",
    "timezone": "string"
}'

PHP

$data = array (
  'cameras' => 
  array (
  ),
  'event_groups' => 
  array (
  ),
  'event_types' => 
  array (
  ),
  'from' => 'date',
  'to' => 'date',
  'timezone' => 'string',
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'POST',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/admin/v1/reports?type=events', false, $context);