Get count reports for devices at location

Get count reports by device for a specified location

POST /api/report/getCountReportsForDevicesAtLocation

Get count reports for devices at location

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/report/getCountReportsForDevicesAtLocation \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "endTimeMs": 1,
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "startTimeMs": 1
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "timeSeriesDataPointsMap": {},
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for getting count reports for devices at a specific location.

endTimeMs · integer<int64> | null · required

End timestamp in epoch milliseconds.

Required range: x >= 0

interval · enum<string> · required

Report interval for filtering face events

Available options: MINUTELY, QUARTERHOURLY, HOURLY, DAILY, WEEKLY, MONTHLY

locationUuid · string<RUUID> | null · required

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

startTimeMs · integer<int64> | null · required

Start timestamp in epoch milliseconds.

Required range: x >= 0

type · enum<string> · required

Type of report to receive

Available options: CROWD, PEOPLE, FACES, MOTION, BANDWIDTH, VEHICLES, LICENSEPLATES, ALERTS, AM_VERIFICATION, DWELL

Response

200 - application/json

OK

Response object for getting count reports.

error · boolean | null

errorMsg · string | null

timeSeriesDataPointsMap · object

Map of UUIDs to their time series data points

Show child attributes

warningMsg · string | null