---
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`

## Request

- Base URL: `https://api.reveldigital.com`
- URL: `https://api.reveldigital.com/adhawk/heatmap`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://id.reveldigital.com/connect/authorize`
    - Token URL: `https://id.reveldigital.com/connect/token` scopes: `webapi`
  - API key in header `X-RevelDigital-ApiKey`
  - API key in query parameter `api_key`
- TypeScript: <https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/docs/adhawk/heatmap/get.ts> (a function with typed inputs; its response is checked against the schema)

## 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.dev/reveldigital/apis/revel-digital-rest-api.md) - [All operations](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/revisions/39d5c8302822?raw)