Sign in

v1

latestOpenAPI 3.0.42026-08-06124112344.5 KB
AdHawk

Gets geographic heatmap data aggregated by location. Useful for heatmap or geographic visualizations.

get/adhawk/heatmap

Query parameters

startDatestring date-time

Start date for the query (required)

endDatestring date-time

End date for the query (required)

deviceIdstring[]

Optional list of device IDs to filter by

interval'Minute' | 'Hour' | 'Day' | 'Week' | 'Month'

Time interval for aggregation (minute, hour, day, week, month)

limitinteger

Maximum number of results (default: 1000, max: 10000)

Response

OK

device_idstring nullable

The device ID

latitudenumber double nullable

Latitude coordinate for the location

longitudenumber double nullable

Longitude coordinate for the location

daystring date-time

Day or period for the aggregated data

countinteger

Total impression count for this location and period

ble_countinteger

Count of BLE beacon impressions

wifi_countinteger

Count of WiFi impressions

motion_countinteger

Count of motion sensor impressions

audience_countinteger

Count of audience/face detection impressions