Sign in

v1

latestOpenAPI 3.0.42026-08-06124112344.5 KB
AdHawk

Gets device play statistics aggregated by device.

get/adhawk/deviceplaystats

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 IDs to filter by

limitinteger

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

Response

OK

device_idstring nullable

The device ID

device_namestring nullable

The device name

total_playsinteger

Total number of media files played on this device

total_durationinteger

Total duration of all plays in seconds

avg_durationnumber double nullable

Average play duration in seconds

file_countinteger

Number of unique media files played on this device

first_playstring date-time nullable

First play timestamp for the period

last_playstring date-time nullable

Last play timestamp for the period