All events

Statistics for user, system, and analytics events for all time

For analytics and system events, please provide the period for which they should be displayed

GET/api/v1/events/dashboard

Headers
Authorization		Bearer token
Accept		application/json
X-Client		ios-cctv\|android-cctv\|thick-legal\|web
X-UUID		unique device id

Body
date^required	string	Date Filtering Template. This field is mandatory when there is no filtering based on the «from» and «to» fields
timezone^required	string	Timezone for the date filtering template and analytics events. Example: Europe/Paris
from^required	string	Starting date for filtering. This field is mandatory when there is no filtering based on the "date" field
to^required	string	Ending date for filtering. This field is mandatory when there is no filtering based on the "date" field

Response
200		Successful response
JSON [ { "type": "analytics", "items": [ { "type": "day", "count": 0 }, { "type": "week", "count": 0 }, { "type": "month", "count": 0 } ] }, { "type": "analytics_detail", "items": [ { "total": 21, "event": { "id": 3, "analytic_type": "face", "name": "unrecognized-face", "description": "Face not identified", "color": "#91D4E2" } }, { "total": 9, "event": { "id": 2, "analytic_type": "face", "name": "recognized-face", "description": "Face identified", "color": "#07D4F0" } } ] }, { "type": "events", "items": [ { "type": "users", "count": 0 }, { "type": "systems", "count": 0 }, { "type": "cameras", "count": 0 } ] } ]
401		Authorization token not provided or invalid, see Obtaining a token

Example

JSON

curl -k --location --request GET 'https://vms.local/api/v1/events/dashboard?date=string&timezone=string&from=string&to=string' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id'