Skip to main content
POST
Get count report

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.

endDate
string | null

End date for the report

Example:

"2024-01-31"

interval
enum<string>

Report interval for filtering face events

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

Scope of the report to reset

Available options:
REGION,
DEVICE,
LOCATION,
ORG
startDate
string | null

Start date for the report

Example:

"2024-01-01"

type
enum<string>

Type of report to receive

Available options:
CROWD,
PEOPLE,
FACES,
MOTION,
BANDWIDTH,
VEHICLES,
LICENSEPLATES,
ALERTS,
DWELL
uuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object for getting count reports.

error
boolean | null
errorMsg
string | null
timeSeriesDataPoints
object[] | null

List of time series data points for count report

warningMsg
string | null
Last modified on August 22, 2026