Skip to main content
POST
Get occupancy counts V2

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 occupancy counts from a device.

deviceUuid
string<DeviceFacetUuid> | null
DeviceFacetUuid

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

endTimeMs
integer<int64> | null
int64

The end timestamp (in Unix epoch milliseconds) of the selected interval

Example:

1640998800000

interval
enum<string>

Report interval for filtering face events

Available options:
MINUTELY,
QUARTERHOURLY,
HOURLY,
DAILY,
WEEKLY,
MONTHLY
startTimeMs
integer<int64> | null
int64

The start timestamp (in Unix epoch milliseconds) of the selected interval

Example:

1640995200000

Response

200 - application/json

OK

Response object for getting occupancy counts from a device.

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

List of time series data points with occupancy counts

warningMsg
string | null
Last modified on July 24, 2026