Skip to content

Create aggregated video metrics report

Request

Create a report of aggregated camera metrics for a given time range and list of cameras.

Security
api_key
Bodyapplication/jsonrequired

request aggregated video metrics data for a set of cameras and a given time range.

cameraIdsArray of strings, (uuid)

A list of IDs of the cameras to fetch the data for.

endDatestring, (date)

It is the upper bound of the date range for which to return data. The endDate is non-inclusive; i.e, the returned data will be for dates from startDate to endDate-1

startDatestring, (date)

It is the lower bound of the date range for which to return data. The startDate is inclusive; i.e, the returned data will be for dates from startDate to endDate-1

timeGrainstring

The time granularity of the response.

Default:"24h"
Enum:"1h""24h""168h"
curl -i -X POST \
  https://coreapi.hoxton.ai/_mock/v1/aggregated-video-metrics-reports \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "cameraIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "endDate": "2019-08-24",
    "startDate": "2019-08-24",
    "timeGrain": "1h"
  }'

Responses

OK.

Bodyapplication/json
Array [
cameraIdstring, (uuid)read-only
lateCountinteger or nullread-only
missingCountinteger or nullread-only
onTimeCountinteger or nullread-only
timestring, (date-time)read-only
]
Response
[
  {
    "cameraId": "cbc3283e-6217-4855-9934-148717cbeefe",
    "lateCount": 0,
    "missingCount": 0,
    "onTimeCount": 0,
    "time": "2019-08-24T14:15:22Z"
  }
]