v1

latestOpenAPI 3.0.42026-08-06124112344.5 KB
AdHawk

Gets aggregated audience metrics for the account.

get/adhawk/audiencemetrics

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)

groupByDeviceboolean

Group by device (default: false). When false, returns totals aggregated only by interval.

includeDwellTimeboolean

Include dwell time data (queries exit events)

limitinteger

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

Response

OK

device_idstring nullable

The device ID

device_namestring nullable

The device name

period_startstring date-time

Start of the time period for these metrics

period_endstring date-time

End of the time period for these metrics

total_impressionsinteger

Total number of impressions detected

unique_visitorsinteger

Number of unique visitors (based on anonymous user IDs)

avg_dwell_timenumber double nullable

Average dwell time in seconds

male_countinteger

Number of male visitors detected

female_countinteger

Number of female visitors detected

unknown_gender_countinteger

Number of visitors with unknown gender

age_under_18integer

Number of visitors under 18 years old

age_18_to_24integer

Number of visitors 18-24 years old

age_25_to_34integer

Number of visitors 25-34 years old

age_35_to_44integer

Number of visitors 35-44 years old

age_45_to_54integer

Number of visitors 45-54 years old

age_55_to_64integer

Number of visitors 55-64 years old

age_65_to_74integer

Number of visitors 65-74 years old

age_over_74integer

Number of visitors over 74 years old

motion_countinteger

Number of motion sensor detections

audience_countinteger

Number of audience/face detections

ble_countinteger

Number of BLE beacon detections

wifi_countinteger

Number of WiFi proximity detections