Report

Get custom events aggregation binary counts

Retrieves aggregated counts of boolean event values (true/false) produced by a selected prompt over a specified time window. Scope & filters: • promptUuid – The prompt to aggregate (required). Time window & interval: • A time range (startTimeMs → endTimeMs, epoch ms) is required and is used exactly as provided. • If an interval is supplied (e.g., MINUTELY, QUARTERHOURLY, HOURLY), events are bucketed at that granularity. • Aggregation is always performed in the device’s local timezone. Buckets are computed relative to each device’s timezone, then evaluated within the exact provided window. Response: • Per interval bucket, returns a BinaryAggregationValue with counts for true and false. • Includes minValueTimestampMs and maxValueTimestampMs (if available) and the bucket timestamp from BaseReportValue. Notes: • Only binary/boolean prompt types are valid for this endpoint.

POST/api/report/getCustomEventsBinaryCounts

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 custom LLM reports.

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

promptUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

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/getCustomEventsBinaryCounts' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "endTimeMs": 1640998800000,
    "interval": "MINUTELY",
    "promptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "startTimeMs": 1640995200000
  }'

import requests

url = "https://api2.rhombussystems.com/api/report/getCustomEventsBinaryCounts"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "endTimeMs": 1640998800000,
    "interval": "MINUTELY",
    "promptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "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/getCustomEventsBinaryCounts', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "endTimeMs": 1640998800000,
    "interval": "MINUTELY",
    "promptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "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 = """
            {
              "endTimeMs": 1640998800000,
              "interval": "MINUTELY",
              "promptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "startTimeMs": 1640995200000
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/report/getCustomEventsBinaryCounts"))
            .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>",
  "reports": {
    "<key>": [
      {
        "eventCount": 0,
        "false": 0,
        "localDate": "<string>",
        "maxValueTimestampMs": 0,
        "minValueTimestampMs": 0,
        "timestampMs": 0,
        "true": 0,
        "utcDate": "<string>"
      }
    ]
  }
}

Response

200 OK

application/json · object

Response object for custom LLM binary reports.

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

reportsobject | null

Map of binary count reports

Show child attributes

eventCountinteger<int64> | null

falseinteger<int64> | null

localDatestring | null

maxValueTimestampMsinteger<int64> | null

minValueTimestampMsinteger<int64> | null

timestampMsinteger<int64> | null

trueinteger<int64> | null

utcDatestring | null

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.