Report Webservice

Get count report

Use /getCountReportV2 instead

post/api/report/getCountReport

Request

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

End date for the report

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

Report interval for filtering face events

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

Scope of the report to reset

startDatestring nullable

Start date for the report

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

Type of report to receive

uuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "endDate": "2024-01-31",
  "startDate": "2024-01-01",
  "uuid": "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
warningMsgstring nullable

Changes

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