Report

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

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request object for getting occupancy counts from a device.

deviceUuidstring<DeviceFacetUuid> | nullbody

RUUID with optional appended facet information

Example: "AAAAAAAAAAAAAAAAAAAAAA.v0"

endTimeMsinteger<int64> | nullbody

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

Example: 1640998800000

intervalenum<string>body

Report interval for filtering face events

Available options: MINUTELY, QUARTERHOURLY, HOURLY, DAILY, WEEKLY, MONTHLY

startTimeMsinteger<int64> | nullbody

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

Example: 1640995200000

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/report/getOccupancyCounts' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "endTimeMs": 1640998800000,
    "interval": "MINUTELY",
    "startTimeMs": 1640995200000
  }'

import requests

url = "https://api2.rhombussystems.com/api/report/getOccupancyCounts"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "endTimeMs": 1640998800000,
    "interval": "MINUTELY",
    "startTimeMs": 1640995200000
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/report/getOccupancyCounts', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "endTimeMs": 1640998800000,
    "interval": "MINUTELY",
    "startTimeMs": 1640995200000
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
              "endTimeMs": 1640998800000,
              "interval": "MINUTELY",
              "startTimeMs": 1640995200000
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/report/getOccupancyCounts"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>",
  "timeSeriesDataPoints": [
    {
      "approximateTimestampMsMap": {
        "<key>": 0
      },
      "dateLocal": "<string>",
      "dateUtc": "<string>",
      "eventCountMap": {
        "<key>": 0
      },
      "reportingDevicesMap": {
        "<key>": [
          "AAAAAAAAAAAAAAAAAAAAAA.v0"
        ]
      },
      "timestampMs": 1640995200000
    }
  ]
}

Response

200 OK

application/json · object

Response object for getting occupancy counts from a device.

errorboolean | null

errorCodestring | null

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

errorMsgstring | null

timeSeriesDataPointsobject[] | null

List of time series data points with occupancy counts

Show child attributes

approximateTimestampMsMapobject | null

A mapping of timestamps (in Unix epoch milliseconds) that indicate, for each type and interval, the point in time where the aggregated occupancy count is closest to the occupancy observed in the corresponding video segment

dateLocalstring | null

dateUtcstring | null

eventCountMapobject | null

reportingDevicesMapobject | null

timestampMsinteger<int64> | null

The representative timestamp (in Unix epoch milliseconds) for the interval

Example: 1640995200000

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.