Sign in

v1

latestOpenAPI 3.0.42026-08-06124112344.5 KB
AdHawk

Gets media impressions (OTS - Opportunity To See) data aggregated by device. Joins audience/impression data with play logs to determine which devices had the most audience engagement during media playback.

get/adhawk/devicemediaimpressions

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

fileIdstring[]

Optional list of file/media IDs to filter by

minDwellThresholdinteger

Minimum dwell time in milliseconds to count as "viewed" (default: 100ms)

limitinteger

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

Response

OK

device_idstring nullable

The device ID

device_namestring nullable

The device name

total_impressionsinteger

Total number of impressions that occurred during media playback

unique_media_countinteger

Number of unique media files played with audience present

net_reachinteger

Net reach - count of impressions with dwell time > 100ms (actually viewed)

ots_percentagenumber double nullable

OTS (Opportunity To See) percentage - ratio of net reach to total impressions

avg_dwell_timenumber double nullable

Average dwell time in seconds for impressions with dwell > 100ms

male_countinteger

Count of male impressions

female_countinteger

Count of female impressions

unknown_gender_countinteger

Count of impressions with unknown gender

avg_agenumber double nullable

Average age of audience members (if available)