Get threshold crossing counts

Get the occupancy counts from threshold crossing for a group of cameras over a period of time

POST /api/report/getThresholdCrossingCounts

Get threshold crossing counts

cURL

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 '
{
  "dailyResetTimeMinute": 0,
  "devices": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "endTimeMs": 1640998800000,
  "startTimeMs": 1640995200000
}
'

200

{
  "counts": [
    {
      "count": 5,
      "timestampMs": 1640995200000
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "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 counts.

crossingObject · enum<string>

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

Show child attributes

error · boolean | null

errorMsg · string | null

warningMsg · string | null