Skip to main content
POST
/
api
/
event
/
getMotionHeatMap
Get aggregated motion heatmap for specified time period and camera
curl --request POST \
  --url https://api2.rhombussystems.com/api/event/getMotionHeatMap \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "endTimeUtcSecs": 1641081600,
  "startTimeUtcSecs": 1640995200
}
'
{
  "countGrid": [
    [
      123
    ]
  ],
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for retrieving motion grid data for a device.

​
deviceUuid
string<DeviceFacetUuid> | null
required

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

​
endTimeUtcSecs
integer<int64> | null
required

End time as a UNIX timestamp in seconds

Example:

1641081600

​
startTimeUtcSecs
integer<int64> | null
required

Start time as a UNIX timestamp in seconds

Example:

1640995200

Response

200 - application/json

OK

Response object containing motion grid counts for a device.

​
countGrid
((integer<int32> | null)[] | null)[] | null

Matrix where each cell is a fraction of the camera's resolution and stores the total number of motion events that occurred in the given timeframe

Matrix where each cell is a fraction of the camera's resolution and stores the total number of motion events that occurred in the given timeframe

Matrix where each cell is a fraction of the camera's resolution and stores the total number of motion events that occurred in the given timeframe

​
error
boolean | null
​
errorMsg
string | null
​
warningMsg
string | null