---
title: "Gets geographic heatmap data aggregated by location.
Useful for heatmap or geographic visualizations."
method: GET
path: "/adhawk/heatmap"
tags: ["AdHawk"]
---

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

`GET /adhawk/heatmap`

## Query parameters

- `startDate` string, date-time
- `endDate` string, date-time
- `deviceId` string[]
- `interval` 'Minute' | 'Hour' | 'Day' | 'Week' | 'Month'
- `limit` integer

## Response `200`

OK

- AdHawkHeatMapData[]
  - `device_id` string, nullable — The device ID
  - `latitude` number, double, nullable — Latitude coordinate for the location
  - `longitude` number, double, nullable — Longitude coordinate for the location
  - `day` string, date-time — Day or period for the aggregated data
  - `count` integer — Total impression count for this location and period
  - `ble_count` integer — Count of BLE beacon impressions
  - `wifi_count` integer — Count of WiFi impressions
  - `motion_count` integer — Count of motion sensor impressions
  - `audience_count` integer — Count of audience/face detection impressions

---

[API](https://skmtc.net/reveldigital/apis/revel-digital-rest-api.md) · [All operations](https://skmtc.net/reveldigital/apis/revel-digital-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/reveldigital/revel-digital-rest-api/versions/f23a94aea621/schema)