Skip to main content
POST
/
api
/
report
/
getCustomEventsReport
Get custom events report
curl --request POST \
  --url https://api2.rhombussystems.com/api/report/getCustomEventsReport \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "deviceFacetUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "endTimeMs": 1640998800000,
  "extendedResponse": true,
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "promptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "startTimeMs": 1640995200000
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "timeSeriesDataPoints": [
    {
      "deviceFacetUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "events": [
        {
          "checkCondition": true,
          "image": "<string>",
          "prompt": "<string>",
          "timestampMs": 123,
          "value": "<string>"
        }
      ],
      "promptType": "COUNT",
      "promptUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for custom LLM reports.

deviceFacetUuids
(string<DeviceFacetUuid> | null)[] | null

Uuids of the selected devices

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

endTimeMs
integer<int64> | null

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

Example:

1640998800000

extendedResponse
boolean | null
locationUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

promptUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

startTimeMs
integer<int64> | null

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

Example:

1640995200000

Response

200 - application/json

OK

Response object for custom LLM reports.

error
boolean | null
errorMsg
string | null
timeSeriesDataPoints
object[] | null

List of time series data points

warningMsg
string | null