Skip to main content
POST
Get aggregated motion heatmap for specified time period and camera

Authorizations

x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme
enum<string>
default:api-token
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.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json

Request object for retrieving motion grid data for a device.

deviceUuid
string<DeviceFacetUuid> | null
required
DeviceFacetUuid

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

endTimeUtcSecs
integer<int64> | null
required
int64

End time as a UNIX timestamp in seconds

Example:

1641081600

startTimeUtcSecs
integer<int64> | null
required
int64

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
Last modified on August 9, 2026