Skip to main content
POST
/
api
/
button
/
getButtonPressEventsForSensor
Get button press events for sensor
curl --request POST \
  --url https://api2.rhombussystems.com/api/button/getButtonPressEventsForSensor \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "createdAfterMs": 1640995200000,
  "createdBeforeMs": 1640995200000,
  "limit": 100,
  "sensorUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "events": [
    {
      "buttonPress": "NONE",
      "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "newSupervisionState": "CUT_DETECTED",
      "pressDurationMillis": 123,
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "correlationId": "<string>",
      "createdAtMs": 123,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "timestampMs": 123,
      "type": "DoorbellEvent",
      "uuid": "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 to get button press events for a specific sensor.

createdAfterMs
integer<int64> | null

Timestamp in milliseconds to get events created after this time

Example:

1640995200000

createdBeforeMs
integer<int64> | null

Timestamp in milliseconds to get events created before this time

Example:

1640995200000

limit
integer<int32> | null

Maximum number of events to return

Example:

100

sensorUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response containing button press events for a sensor.

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

List of button press events for the sensor

warningMsg
string | null