AdHawk

Gets device play statistics aggregated by device.

get/adhawk/deviceplaystats

Request

Base URL
https://api.reveldigital.com
Auth
- OAuth 2
  Authorization codehttps://id.reveldigital.com/connect/authorize
  Token URLhttps://id.reveldigital.com/connect/token
  Scopeswebapi
- or API key in header X-RevelDigital-ApiKey
- or API key in query parameter api_key
TypeScript
https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/docs/adhawk/deviceplaystats/get.ts
A function with typed inputs. Its response is checked against the schema.

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)

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

No recorded changes to this operation across all 3 revisions of this API.