Skip to main content
POST
/
api
/
report
/
getOccupancyCounts
Get occupancy counts
curl --request POST \
  --url https://api2.rhombussystems.com/api/report/getOccupancyCounts \
  --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": {},
      "timestampMs": 1640995200000
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for getting occupancy counts from a device.

deviceUuid
string<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

endTimeMs
integer<int64> | null

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

Example:

1640998800000

interval
enum<string> | null

The interval defines the granularity at which the results will be reported

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

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