Report Webservice

Get threshold crossing events for device

Get threshold crossing events for device

post/api/report/getThresholdCrossingEventsForDevice

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/report/getThresholdCrossingEventsForDevice
  • 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'
deviceUuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

endTimeMsinteger nullable

End timestamp of query period in epoch MS

lastEvaluatedKeystring nullable

Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page

maxPageSizeinteger nullable

Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available

startTimeMsinteger nullable

Start timestamp of query period in epoch MS

Example request

{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "endTimeMs": 1640998800000,
  "maxPageSize": 100,
  "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
lastEvaluatedKeystring nullable

If a max page size was specified and there are additional results that can be retrieved this will be non-null and should be supplied in the next request to retrieve the next page of results

warningMsgstring nullable

Changes

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