Report Webservice

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

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/report/getThresholdCrossingCounts
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

crossingObject'HUMAN' | 'VEHICLE' | 'FACE' | 'LPR' | 'POSE' | 'CLIP_EMBED' | 'UNKNOWN'
dailyResetTimeMinuteinteger nullable

Daily reset time in minutes

devicesstring[] nullable

List of device UUIDs to get threshold crossing counts for

endTimeMsinteger nullable

End time in milliseconds

startTimeMsinteger nullable

Start time in milliseconds

Example request

{
  "devices": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "endTimeMs": 1640998800000,
  "startTimeMs": 1640995200000
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "counts": [
    {
      "count": 5,
      "timestampMs": 1640995200000
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.