Report Webservice

Get occupancy counts

Returns the estimated occupancy count for a specified room or area within a given time range. This endpoint allows you to monitor occupancy trends over time or retrieve a single count for a defined interval. 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.

post/api/report/getOccupancyCounts

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/report/getOccupancyCounts
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

deviceUuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

endTimeMsinteger nullable

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

interval'MINUTELY' | 'QUARTERHOURLY' | 'HOURLY' | 'DAILY' | 'WEEKLY' | 'MONTHLY'

Report interval for filtering face events

startTimeMsinteger nullable

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

Example request

{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "endTimeMs": 1640998800000,
  "startTimeMs": 1640995200000
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "timeSeriesDataPoints": [
    {
      "timestampMs": 1640995200000
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.