v1

latestOpenAPI 3.0.42026-08-06124112344.5 KB

AdHawk

Gets aggregated event metrics for the account.

get/adhawk/eventmetrics

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

eventNamestring[]

Optional list of event names to filter by

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

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

groupByDeviceboolean

Group by device (default: false). When false and groupByEvent is also false, returns totals aggregated only by interval.

groupByEventboolean

Group by event name (default: false)

limitinteger

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

device_idstring nullable

The device ID

device_namestring nullable

The device name

event_namestring nullable

The event name (when grouping by event)

period_startstring date-time

Start of the time period for these metrics

period_endstring date-time

End of the time period for these metrics

total_eventsinteger

Total number of events

unique_sessionsinteger

Number of unique sessions

unique_event_namesinteger nullable

Number of unique event names (when not grouping by event)

unique_devicesinteger nullable

Number of unique devices (when not grouping by device)