Report Webservice

Get threshold crossing count report for device

Get threshold crossing count report for device

post/api/report/getThresholdCrossingCountReport

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/report/getThresholdCrossingCountReport
  • 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

bucketSize'QUARTER_HOUR' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH'

Size of the report buckets

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

Whether to deduplicate the results

deviceUuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

endTimeMsinteger nullable

End time in milliseconds

startTimeMsinteger nullable

Start time in milliseconds

timeZonestring nullable

String of timezone for bucketing

Example request

{
  "dedupe": true,
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "endTimeMs": 1640998800000,
  "startTimeMs": 1640995200000,
  "timeZone": "America/Los_Angeles"
}

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

Changes

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