Get minimal state events for environmental gateway

Get list of events for environmental gateways in minimal state

POST /api/climate/getMinimalStateEventsForEnvironmentalGateway

Get minimal state events for environmental gateway

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/climate/getMinimalStateEventsForEnvironmentalGateway \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "createdAfterMs": 1640991600000,
  "createdBeforeMs": 1640995200000,
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "lastEvaluatedKey": "<string>",
  "maxPageSize": 50
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "lastEvaluatedKey": "<string>",
  "minimalEnvironmentalGatewayStates": [
    {
      "activities": [],
      "airQualityIndex": 45,
      "alertTriggers": [],
      "associatedCameras": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "calibrating": false,
      "ch2oPpb": 15.7,
      "co2Ppm": 450,
      "coConcentration": 2.1,
      "connected": true,
      "createdAtMillis": 1640995200000,
      "defaultInterfaceMac": "00:1A:2B:3C:4D:5E",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "externalIPAddress": "203.0.113.1",
      "falsePositiveConfidencePercent": 5.2,
      "firmwareVersion": "2.1.5",
      "floorNumber": 2,
      "heatIndexDegF": 85.2,
      "iaq": 85.5,
      "lanAddresses": [
        "<string>"
      ],
      "latitude": 37.7749,
      "leakDetected": false,
      "leakProbePresent": true,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "longitude": -122.4194,
      "name": "Main Office Gateway",
      "nc0p5": 120.5,
      "nc10p0": 15.3,
      "nc1p0": 85.2,
      "nc2p5": 45.8,
      "nc4p0": 32.1,
      "noxIdx": 88.2,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "pm10p0": 18.9,
      "pm1p0": 8.5,
      "pm2p5": 12.3,
      "pm4p0": 15.7,
      "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "pressure": 1013.25,
      "probeTempC": 24.5,
      "relHumid": 45.2,
      "serialNumber": "EG-123456789",
      "smokeConfidencePercent": 92.8,
      "smokeTobaccoConfidencePercent": 88.1,
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "tempC": 23.5,
      "tempProbePresent": true,
      "timestampMs": 1640995200000,
      "typPartSize": 2.8,
      "vapeConfidencePercent": 85.5,
      "vapeDetected": false,
      "vapeThcConfidencePercent": 72.3,
      "vocIdx": 125.5
    }
  ],
  "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 to retrieve events for an environmental gateway.

createdAfterMs · integer<int64> | null

Timestamp in milliseconds after which events should be retrieved

Example:

1640991600000

createdBeforeMs · integer<int64> | null

Timestamp in milliseconds before which events should be retrieved

Example:

1640995200000

deviceUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

lastEvaluatedKey · string | null

maxPageSize · integer<int32> | null

Maximum number of results to return per page

Example:

50

Response

200 - application/json

OK

Response containing minimal environmental gateway states.

error · boolean | null

errorMsg · string | null

lastEvaluatedKey · string | null

minimalEnvironmentalGatewayStates · object[] | null

List of minimal environmental gateway states

Show child attributes

warningMsg · string | null