Get recent policy alerts for organization

Get recent policy alerts for organization

POST /api/event/getPolicyAlerts

Get recent policy alerts for organization

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/event/getPolicyAlerts \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "accessControlledDoorFilter": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "afterTimestampMs": 1640995200000,
  "beforeTimestampMs": 1641081600000,
  "deviceFilter": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "lastTimestampMs": 1640995200000,
  "lastUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "locationFilter": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "maxResults": 100
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "policyAlerts": [
    {
      "airQualityIndex": 123,
      "airQualityIndexThreshold": 123,
      "alertingDwellEvents": [
        {
          "deviceLabels": [
            "<string>"
          ],
          "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "durationSec": 123,
          "dwellStartTimeMs": 123,
          "locationLabels": [
            "<string>"
          ],
          "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "regionUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
          "thumbnailLocation": "<string>",
          "thumbnailUri": "<string>",
          "timestampMs": 123,
          "trackId": 123
        }
      ],
      "alertingEventFaces": [
        {
          "faceId": "<string>",
          "faceName": "<string>",
          "imageS3Bucket": "<string>",
          "imageS3Key": "<string>",
          "imageS3Region": "<string>",
          "labels": [
            "<string>"
          ],
          "personUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      ],
      "alertingEventVehicles": [
        {
          "imageS3Bucket": "<string>",
          "imageS3Key": "<string>",
          "imageS3Region": "<string>",
          "labels": [
            "<string>"
          ],
          "licensePlateNumber": "<string>",
          "vehicleName": "<string>"
        }
      ],
      "cd": "<string>",
      "cdn": "<string>",
      "ch2oPpb": 123,
      "ch2oPpbThreshold": 123,
      "clipLocation": {
        "region": "<string>"
      },
      "cllmBooleanValue": true,
      "cllmCheckCondition": {
        "value": "<string>"
      },
      "cllmIntegerValue": 123,
      "cllmPromptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "co2": 123,
      "co2Ppm": 123,
      "co2PpmThreshold": 123,
      "co2Threshold": 123,
      "coConcentration": 123,
      "coConcentrationThreshold": 123,
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "egressBoundaryDevices": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "ethanol": 123,
      "ethanolThreshold": 123,
      "heatIndexDegF": 123,
      "heatIndexDegFThreshold": 123,
      "humidityPercent1616": 123,
      "humidityPercentThreshold1616": 123,
      "humidityPermyriad": 123,
      "humidityThresholdPermyriad": 123,
      "iaq": 123,
      "iaqThreshold": 123,
      "ingressBoundaryDevices": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "leakDetected": true,
      "maxLuf": 123,
      "noxIdx": 123,
      "noxIdxThreshold": 123,
      "numHumans": 123,
      "peopleCountHighThreshold": 123,
      "peopleCountLowThreshold": 123,
      "pm10p0": 123,
      "pm10p0Threshold": 123,
      "pm1p0": 123,
      "pm1p0Threshold": 123,
      "pm25": 123,
      "pm25Threshold": 123,
      "pm4p0": 123,
      "pm4p0Threshold": 123,
      "pressure": 123,
      "pressureThreshold": 123,
      "probeTempC": 123,
      "probeTempCThreshold": 123,
      "probeTempThreshold": 123,
      "relHumid": 123,
      "relHumidThreshold": 123,
      "tamperByMovementChange": 123,
      "tampered": true,
      "tempC": 123,
      "tempCThreshold": 123,
      "tempProbePresent": true,
      "temperatureCelsius1616": 123,
      "temperatureCelsiusThreshold1616": 123,
      "temperaturePermyriad": 123,
      "temperatureThresholdPermyriad": 123,
      "thcPercent": 123,
      "thcPercentThreshold": 123,
      "tvoc": 123,
      "tvocThreshold": 123,
      "vapeDetected": true,
      "vapeSmokePercent": 123,
      "vapeSmokePercentThreshold": 123,
      "vocIdx": 123,
      "vocIdxThreshold": 123,
      "alertMonitoringThreatCaseUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "alertMonitoringVerified": true,
      "archived": true,
      "clipLocationMap": {},
      "clipLocationMapV2": {},
      "delayedProcessing": true,
      "deleted": true,
      "durationSec": 123,
      "finalized": true,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "notificationSent": true,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "policyAlertTriggers": [],
      "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "saved": true,
      "shared": true,
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "textDescription": "<string>",
      "thumbnailLocation": {
        "region": "<string>"
      },
      "thumbnailLocationV2": "<string>",
      "timestampMs": 123,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "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 retrieving policy alerts with filtering and pagination options.

accessControlledDoorFilter · (string<RUUID> | null)[] | null

Filter including chosen Access Controlled Doors

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

afterTimestampMs · integer<int64> | null

Enter starting timestamp interval in UNIX ms

Example:

1640995200000

beforeTimestampMs · integer<int64> | null

Enter ending timestamp interval in UNIX ms

Example:

1641081600000

deviceFilter · (string<RUUID> | null)[] | null

Filter including chosen Devices

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

lastTimestampMs · integer<int64> | null

Search with last known TimestampMs (Required for Pagination)

Example:

1640995200000

lastUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

locationFilter · (string<RUUID> | null)[] | null

Filter any locations you would like to include

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

maxResults · integer<int32> | null

Set a max result limit

Example:

100

Response

200 - application/json

object | null

OK

Response object containing a list of policy alerts.

error · boolean | null

errorMsg · string | null

policyAlerts · object[] | null

List of policy alerts matching the request criteria

List of recent unarchived policy alerts matching the filter criteria

Option 1

Option 2

Show child attributes

warningMsg · string | null