v1

latestOpenAPI 3.0.42026-08-06124112344.5 KB

AdHawk

Gets audience impressions for the account.

get/adhawk/impressions

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

typeinteger[]

Optional list of impression types to filter by

gender'Unknown' | 'Female' | 'Male'

Gender classification for audience analytics

Optional gender to filter by

minDwellTimeinteger

Minimum dwell time in milliseconds

limitinteger

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

Response

idstring nullable

Unique identifier for this impression entry

timestampstring date-time

Timestamp when the impression was recorded

device_idstring nullable

The device ID where the impression was detected

typeinteger

Type of impression detection. Types are bitfield values: <list type="bullet"><item><description>8 = motion</description></item><item><description>64 = audience</description></item><item><description>128 = ble</description></item><item><description>256 = wifi</description></item></list>

dwell_timeinteger nullable

Dwell time in milliseconds - how long the visitor was detected

user_idstring nullable

Anonymous user identifier for tracking unique visitors

gender'Unknown' | 'Female' | 'Male'

Gender classification for audience analytics

ageinteger nullable

Estimated age of the visitor

Age range classification for audience analytics

rssiinteger nullable

Received Signal Strength Indicator for BLE/WiFi detections

utc_offsetinteger nullable

UTC offset of the device at the time of detection