Get batch threshold crossing count report

Get batch threshold crossing count report

POST /api/report/getBatchThresholdCrossingCountReport

Get batch threshold crossing count report

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/report/getBatchThresholdCrossingCountReport \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "dedupe": true,
  "deviceUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "endTimeMs": 1640998800000,
  "startTimeMs": 1640995200000,
  "timeZone": "America/Los_Angeles"
}
'

200

{
  "crossingCounts": [
    {
      "egressCount": 123,
      "ingressCount": 123,
      "timestampMs": 123
    }
  ],
  "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 batch threshold crossing count reports.

bucketSize · enum<string>

Size of the report buckets

Available options: QUARTER_HOUR, HOUR, DAY, WEEK, MONTH

crossingObject · enum<string>

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

dedupe · boolean | null

Whether to deduplicate the results

Example:

true

deviceUuids · (string<DeviceFacetUuid> | null)[] | null

UUID of devices to get threshold crossing count report for

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

endTimeMs · integer<int64> | null

End time in milliseconds

Example:

1640998800000

startTimeMs · integer<int64> | null

Start time in milliseconds

Example:

1640995200000

timeZone · string | null

String of timezone for bucketing

Example:

"America/Los_Angeles"

Response

200 - application/json

OK

Response object for getting threshold crossing count reports.

crossingCounts · object[] | null

List of crossing counts

Show child attributes

error · boolean | null

errorMsg · string | null

warningMsg · string | null