Export Webservice

Download count report

Download count report

post/api/export/countReports

Request

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

Enter the ending date in in ISO 8601 format

endTimeMsinteger nullable required

End datetime 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

Enter the starting date in ISO 8601 format

startTimeMsinteger nullable required

Start datetime 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

uuidListstring[] nullable

Enter the UUID of device(s) or location(s)

Example request

{
  "endDate": "2024-07-17T00:00:00Z",
  "endTimeMs": 1721416242907,
  "startDate": "2024-07-17T00:00:00Z",
  "startTimeMs": 1719861042000,
  "timeZone": "America/Los_Angeles",
  "uuidList": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ]
}

Response

OK

Changes

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