Sign in

v1

latestOpenAPI 3.0.42026-08-06124112344.5 KB
AdHawk

Gets time-series play statistics aggregated by interval.

get/adhawk/playstatsbytime

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

interval'Minute' | 'Hour' | 'Day' | 'Week' | 'Month'

Time interval for aggregation (minute, hour, day, week, month)

groupByDeviceboolean

Group by device

groupByFileboolean

Group by file

limitinteger

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

Response

OK

device_idstring nullable

Optional device ID (null if aggregated across all devices)

device_namestring nullable

Optional device name

file_idstring nullable

Optional file ID (null if aggregated across all files)

file_namestring nullable

Optional file name

period_startstring date-time

Start of the time period for these stats

period_endstring date-time

End of the time period for these stats

total_playsinteger

Total number of plays during this period

total_durationinteger

Total duration of all plays in seconds

avg_durationnumber double nullable

Average play duration in seconds

device_countinteger nullable

Number of unique devices (if aggregated by file)

file_countinteger nullable

Number of unique files (if aggregated by device)