Skip to main content
POST
/
api
/
report
/
getThresholdCrossingEventsForDevice
Get threshold crossing events for device
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 '
{
  "crossingObject": "HUMAN",
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "endTimeMs": 1640998800000,
  "lastEvaluatedKey": "<string>",
  "maxPageSize": 100,
  "startTimeMs": 1640995200000
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "lastEvaluatedKey": "<string>",
  "thresholdCrossingEvents": [
    {
      "crossingObject": "HUMAN",
      "direction": "INGRESS",
      "objectId": 123,
      "timestampMs": 123
    }
  ],
  "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 object for getting threshold crossing events for a specific device.

​
crossingObject
enum<string> | null

Type of crossing object for events returned, ie HUMAN/VEHICLE, defaults to all types if null

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

​
warningMsg
string | null