Report Webservice

Get count reports

Get multiple specified count reports

post/api/report/getCountReports

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/report/getCountReports
  • 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

endDatestring nullable

Deprecated input, use endTimeMs instead

endTimeMsinteger nullable

End datetime provided as a UNIX timestamp in milliseconds

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

Report interval for filtering face events

scope'REGION' | 'DEVICE' | 'LOCATION' | 'ORG' required

Scope of the report to reset

startDatestring nullable

Deprecated input, use startTimeMs instead

startTimeMsinteger nullable

Start datetime provided as a UNIX timestamp in milliseconds

timeZonestring nullable

String of timezone for bucketing

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

Type of report to receive

Example request

{
  "timeZone": "America/Los_Angeles"
}

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.