Report Webservice

Get custom events report

Retrieves a custom events report containing raw time-series event values recorded by selected prompts and devices within the specified time window. The report can be filtered by: • promptUuid – The specific prompt to query. • deviceFacetUuids – A set of devices to include. • locationUuid – The location context for the query. For example, a request may specify a promptUuid to fetch results from a certain LLM prompt, and additionally restrict results to only devices in a given locationUuid. The time range (startTimeMs → endTimeMs) is required and determines the interval of events returned. The response includes, per device and prompt, the raw event values (numeric or boolean as string) along with timestamps, check-condition results (if selected), and prompt type.

post/api/report/getCustomEventsReport

Request

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

deviceFacetUuidsstring[] nullable

Uuids of the selected devices

endTimeMsinteger nullable

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

extendedResponseboolean nullable
locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

promptUuidstring RUUID nullable

base 64 (url-safe) uuid string

startTimeMsinteger nullable

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

Example request

{
  "deviceFacetUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "endTimeMs": 1640998800000,
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "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
warningMsgstring nullable

Example response

{
  "timeSeriesDataPoints": [
    {
      "deviceFacetUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "promptUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

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