Report Webservice

Get count reports for devices at location

Get count reports by device for a specified location

post/api/report/getCountReportsForDevicesAtLocation

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/report/getCountReportsForDevicesAtLocation
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

endTimeMsinteger nullable required

End timestamp in epoch milliseconds.

interval'MINUTELY' | 'QUARTERHOURLY' | 'HOURLY' | 'DAILY' | 'WEEKLY' | 'MONTHLY' required

Report interval for filtering face events

locationUuidstring RUUID nullable required

base 64 (url-safe) uuid string

startTimeMsinteger nullable required

Start timestamp in epoch milliseconds.

type'CROWD' | 'PEOPLE' | 'FACES' | 'MOTION' | 'BANDWIDTH' | 'VEHICLES' | 'LICENSEPLATES' | 'ALERTS' | 'DWELL' required

Type of report to receive

Example request

{
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
timeSeriesDataPointsMapobject nullable

Map of UUIDs to their time series data points

warningMsgstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.