Skip to main content
POST
Get count reports

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.

interval
enum<string>
required

Report interval for filtering face events

Available options:
MINUTELY,
QUARTERHOURLY,
HOURLY,
DAILY,
WEEKLY,
MONTHLY
scope
enum<string>
required

Scope of the report to reset

Available options:
REGION,
DEVICE,
LOCATION,
ORG
type
enum<string>
required

Type of report to receive

Available options:
CROWD,
PEOPLE,
FACES,
MOTION,
BANDWIDTH,
VEHICLES,
LICENSEPLATES,
ALERTS,
DWELL
endDate
string | null
deprecated
deprecated

Deprecated input, use endTimeMs instead

endTimeMs
integer<int64> | null
int64

End datetime provided as a UNIX timestamp in milliseconds

Required range: x >= 0
startDate
string | null
deprecated
deprecated

Deprecated input, use startTimeMs instead

startTimeMs
integer<int64> | null
int64

Start datetime provided as a UNIX timestamp in milliseconds

Required range: x >= 0
timeZone
string | null

String of timezone for bucketing

Example:

"America/Los_Angeles"

Response

200 - application/json

OK

Response object for getting count reports.

error
boolean | null
errorMsg
string | null
timeSeriesDataPointsMap
object | null

Map of UUIDs to their time series data points

warningMsg
string | null
Last modified on August 21, 2026