Get threshold crossing events for device

Get threshold crossing events for device

POST /api/report/getThresholdCrossingEventsForDevice

Get threshold crossing events for device

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/report/getThresholdCrossingEventsForDevice \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "endTimeMs": 1640998800000,
  "lastEvaluatedKey": "<string>",
  "maxPageSize": 100,
  "startTimeMs": 1640995200000
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "lastEvaluatedKey": "<string>",
  "thresholdCrossingEvents": [
    {
      "objectId": 123,
      "timestampMs": 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 threshold crossing events for a specific device.

crossingObject · enum<string>

Available options: HUMAN, VEHICLE, FACE, LPR, POSE, CLIP_EMBED, UNKNOWN

deviceUuid · string<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

endTimeMs · integer<int64> | null

End timestamp of query period in epoch MS

Example:

1640998800000

lastEvaluatedKey · string | null

Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page

maxPageSize · integer<int32> | null

Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available

Example:

100

startTimeMs · integer<int64> | null

Start timestamp of query period in epoch MS

Example:

1640995200000

Response

200 - application/json

OK

Response object for getting threshold crossing events for a specific device.

error · boolean | null

errorMsg · string | null

lastEvaluatedKey · string | null

If a max page size was specified and there are additional results that can be retrieved this will be non-null and should be supplied in the next request to retrieve the next page of results

thresholdCrossingEvents · object[] | null

List of threshold crossing events for the device

Show child attributes

warningMsg · string | null