Report Webservice

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

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/report/getCustomEventsBinaryCounts
  • 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

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

promptUuidstring RUUID nullable

base 64 (url-safe) uuid string

startTimeMsinteger nullable

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

Example request

{
  "endTimeMs": 1640998800000,
  "promptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "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
reportsobject nullable

Map of binary count reports

warningMsgstring nullable

Changes

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