Skip to main content
POST
/
api
/
report
/
getThresholdCrossingEvents
Get threshold crossing events
curl --request POST \
  --url https://api2.rhombussystems.com/api/report/getThresholdCrossingEvents \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "crossingObject": "HUMAN",
  "devices": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "endTimeMs": 1640998800000,
  "startTimeMs": 1640995200000
}
'
{
  "deviceToThresholdCrossingEventMap": {},
  "error": true,
  "errorMsg": "<string>",
  "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.

​
crossingObject
enum<string> | null

Type of crossing object to get events for

Available options:
HUMAN,
VEHICLE,
FACE,
LPR,
POSE,
CLIP_EMBED,
UNKNOWN
​
devices
(string<RUUID> | null)[] | null

List of device UUIDs to get threshold crossing events for

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
endTimeMs
integer<int64> | null

End time in milliseconds

Example:

1640998800000

​
startTimeMs
integer<int64> | null

Start time in milliseconds

Example:

1640995200000

Response

200 - application/json

OK

Response object for getting threshold crossing events.

​
deviceToThresholdCrossingEventMap
object

Map of device UUIDs to their threshold crossing events

​
error
boolean | null
​
errorMsg
string | null
​
warningMsg
string | null