🚧 The Rhombus Developer Documentation is currently in beta. For the official documentation, please visit docs.rhombus.com.
curl --request POST \
--url https://api2.rhombussystems.com/api/report/getOccupancyCountsV2 \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
"endTimeMs": 1640998800000,
"interval": "MINUTELY",
"startTimeMs": 1640995200000
}
'{
"error": true,
"errorMsg": "<string>",
"timeSeriesDataPoints": [
{
"approximateTimestampMsMap": {},
"dateLocal": "<string>",
"dateUtc": "<string>",
"eventCountMap": {},
"reportingDevicesMap": {},
"timestampMs": 1640995200000
}
],
"warningMsg": "<string>"
}Returns the estimated occupancy count for a specified room or area within a given time range using person reidentification data. Important: An occupancy region must be defined in the Rhombus Console before using this endpoint. You can optionally specify an interval (e.g., MINUTELY, QUARTERHOURLY, HOURLY …) to retrieve occupancy counts broken down by sub-intervals between startTime and endTime. If no interval is provided, a single occupancy count is returned for the entire duration between startTime and endTime.
curl --request POST \
--url https://api2.rhombussystems.com/api/report/getOccupancyCountsV2 \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
"endTimeMs": 1640998800000,
"interval": "MINUTELY",
"startTimeMs": 1640995200000
}
'{
"error": true,
"errorMsg": "<string>",
"timeSeriesDataPoints": [
{
"approximateTimestampMsMap": {},
"dateLocal": "<string>",
"dateUtc": "<string>",
"eventCountMap": {},
"reportingDevicesMap": {},
"timestampMs": 1640995200000
}
],
"warningMsg": "<string>"
}Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
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.
api-token, api, partner-api-token, partner-api Request object for getting occupancy counts from a device.
RUUID with optional appended facet information
"AAAAAAAAAAAAAAAAAAAAAA.v0"
The end timestamp (in Unix epoch milliseconds) of the selected interval
1640998800000
Report interval for filtering face events
MINUTELY, QUARTERHOURLY, HOURLY, DAILY, WEEKLY, MONTHLY The start timestamp (in Unix epoch milliseconds) of the selected interval
1640995200000
Was this page helpful?