---
title: "Gets aggregated audience metrics for the account."
method: GET
path: "/adhawk/audiencemetrics"
tags: ["AdHawk"]
---

# Gets aggregated audience metrics for the account.

`GET /adhawk/audiencemetrics`

## Request

- Base URL: `https://api.reveldigital.com`
- URL: `https://api.reveldigital.com/adhawk/audiencemetrics`
- 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/audiencemetrics/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'
- `groupByDevice` boolean
- `includeDwellTime` boolean
- `limit` integer

## Response `200`

OK

- AdHawkAudienceMetrics[]
  - `device_id` string, nullable: The device ID
  - `device_name` string, nullable: The device name
  - `period_start` string, date-time: Start of the time period for these metrics
  - `period_end` string, date-time: End of the time period for these metrics
  - `total_impressions` integer: Total number of impressions detected
  - `unique_visitors` integer: Number of unique visitors (based on anonymous user IDs)
  - `avg_dwell_time` number, double, nullable: Average dwell time in seconds
  - `male_count` integer: Number of male visitors detected
  - `female_count` integer: Number of female visitors detected
  - `unknown_gender_count` integer: Number of visitors with unknown gender
  - `age_under_18` integer: Number of visitors under 18 years old
  - `age_18_to_24` integer: Number of visitors 18-24 years old
  - `age_25_to_34` integer: Number of visitors 25-34 years old
  - `age_35_to_44` integer: Number of visitors 35-44 years old
  - `age_45_to_54` integer: Number of visitors 45-54 years old
  - `age_55_to_64` integer: Number of visitors 55-64 years old
  - `age_65_to_74` integer: Number of visitors 65-74 years old
  - `age_over_74` integer: Number of visitors over 74 years old
  - `motion_count` integer: Number of motion sensor detections
  - `audience_count` integer: Number of audience/face detections
  - `ble_count` integer: Number of BLE beacon detections
  - `wifi_count` integer: Number of WiFi proximity detections

---

[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)