Event Webservice

Get aggregated motion heatmap for specified time period and camera

Get aggregated motion heatmap for specified time period and camera. Divides a camera's resolution into a 36x64 grid and counts the number of motion events that occurred in each cell.

post/api/event/getMotionHeatMap

Request

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

deviceUuidstring DeviceFacetUuid nullable required

RUUID with optional appended facet information

endTimeUtcSecsinteger nullable required

End time as a UNIX timestamp in seconds

startTimeUtcSecsinteger nullable required

Start time as a UNIX timestamp in seconds

Example request

{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "endTimeUtcSecs": 1641081600,
  "startTimeUtcSecs": 1640995200
}

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.