Skip to main content
POST
/
api
/
report
/
getThresholdCrossingCounts
Get threshold crossing counts
curl --request POST \
  --url https://api2.rhombussystems.com/api/report/getThresholdCrossingCounts \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "crossingObject": "HUMAN",
  "dailyResetTimeMinute": 0,
  "devices": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "endTimeMs": 1640998800000,
  "startTimeMs": 1640995200000
}
'
{
  "counts": [
    {
      "count": 5,
      "timestampMs": 1640995200000
    }
  ],
  "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 counts.

crossingObject
enum<string> | null

Type of crossing object to count

Available options:
HUMAN,
VEHICLE,
FACE,
LPR,
POSE,
CLIP_EMBED,
UNKNOWN
dailyResetTimeMinute
integer<int32> | null

Daily reset time in minutes

Example:

0

devices
(string<RUUID> | null)[] | null

List of device UUIDs to get threshold crossing counts 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 counts.

counts
object[] | null

List of threshold crossing counts

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