Analytics. Dashboard

Analytics event statistics for a period

GET/api/v1/events/dashboard/analytics/detailed

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. Example: Europe/Paris. This field is mandatory when filtering by date
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_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" } } ] } ]`
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/analytics/detailed?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'