Get sensor activity seekpoints for sensor

Retrieves sensor activity seekpoints for a specific sensor within a given time range. Returns footage seekpoints that correspond to events detected by the specified sensor device.

POST /api/sensors/getFootageSensorSeekpointsForSensor

Get sensor activity seekpoints for sensor

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/sensors/getFootageSensorSeekpointsForSensor \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "durationSec": 3600,
  "sensorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "startTimeSec": 1640995200
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "footageSeekPoints": [
    {
      "ts": 123,
      "al": true,
      "cd": "<string>",
      "cdn": "<string>",
      "dcao": true,
      "dwelling": true,
      "fn": "<string>",
      "id": 123,
      "loudness": 123,
      "lp": "<string>",
      "m": true,
      "p": "<string>",
      "ro": [
        "<string>"
      ],
      "sensorValType": {
        "sensorBoolean": true,
        "sensorDouble": 123,
        "sensorLong": 123
      },
      "stableTrackId": 123,
      "toi": {
        "employeeName": "<string>",
        "guid": "<string>",
        "locationName": "<string>",
        "restaurantName": "<string>",
        "toastCheckInfo": {
          "totalAmount": 123
        }
      },
      "tu": "<string>",
      "uf": "<string>",
      "vn": "<string>"
    }
  ],
  "seekPoints": [
    {
      "ts": 123,
      "al": true,
      "cd": "<string>",
      "cdn": "<string>",
      "co2": 123,
      "cu": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "ethanol": 123,
      "h": 123,
      "heatIndexDegF": 123,
      "hp": 123,
      "iaq": 123,
      "lu": "AAAAAAAAAAAAAAAAAAAAAA",
      "pm25": 123,
      "probeTempC": 123,
      "sn": "Motion Sensor 1",
      "su": "AAAAAAAAAAAAAAAAAAAAAA",
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "t": 123,
      "tc": 123,
      "thcPercent": 123,
      "tvoc": 123,
      "vapeSmokePercent": 123
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · 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.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for getting sensor seekpoints for a specific sensor.

durationSec · integer<int32> | null

Duration in seconds for the query period

Example:

3600

sensorUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

startTimeSec · integer<int64> | null

Start time in seconds for the query period

Example:

1640995200

Response

200 - application/json

OK

Response object for getting sensor seekpoints for a specific sensor.

error · boolean | null

errorMsg · string | null

footageSeekPoints · object[] | null

List of footage seekpoints for the sensor

Show child attributes

seekPoints · object[] | null

List of sensor seekpoints for the sensor

Show child attributes

warningMsg · string | null