Sign in

v1

latestOpenAPI 3.0.42026-08-06124112344.5 KB
AdHawk

Returns AdHawk dataset based on the provided post parameters. This is a legacy endpoint that returns raw dataset results. Consider using the newer typed endpoints for better structure.

post/adhawk/dataset

Request body

dataset_type'ImpressionTotals' | 'GenderTotals' | 'DailyImpressions' | 'DwellRange' | 'AgeRange' | 'DayOfWeekByHourHeatmap' | 'ImpressionsByGenderByDay' | 'ImpressionsByAgeGroupByDay' | 'GenderAgeHeatmap' | 'DailyAverageDwell' | 'ImpressionsByDeviceAndPingType' | 'ImpressionsByMedia' | 'EventsTotals' | 'DailyEvents' | 'EventsByEventName' | 'EventsByDeviceName' | 'EventsByDeviceCountry' | 'AverageDwellByEventName' | 'EventsBySession' | 'AverageDwellBySession' | 'AverageEventsByNameAndSession' | 'NetworkPingTotals' | 'NetworkAlertTotals' | 'NetworkAlertsByLocation' required

This enumeration defines the different categories of datasets that can be used for analytics and reporting within the AdHawk platform. Each value corresponds to a specific type of data aggregation or analysis, such as impressions, demographics, dwell times, events, or network-related metrics.

The following AdHawk dataset types are available:

ImpressionTotals: Total audience impressions for the given time period GenderTotals: Audience impression totals grouped by gender DailyImpressions: Total impressions grouped by interval (day, week, month, hour, minute) DwellRange: Impressions grouped by the following dwell ranges in seconds: 0-5, 5-10, 10-15, 15-30, 30-45, 45-60, 60-120, 120+ AgeRange: Impressions grouped by the following age ranges: 0-17, 18-24, 25-34, 35-44, 45-54, 55-64, 65-74, 75+ DayOfWeekByHourHeatmap: Impressions grouped by day of week and hour of day ImpressionsByGenderByDay: Impressions grouped by gender and day ImpressionsByAgeGroupByDay: Impressions grouped by age group and day GenderAgeHeatmap: Impressions grouped by gender and age DailyAverageDwell: Average dwell time by day ImpressionsByDeviceAndPingType: Impressions grouped by device and ping type ImpressionsByMedia: Impressions grouped by media

EventsTotals: Total events and sessions for the given time period DailyEvents: Total events grouped by interval (day, week, month, hour, minute) EventsByEventName: Total events grouped by event name EventsByDeviceName: Total events grouped by device name EventsByDeviceCountry: Total events grouped by device country AverageDwellByEventName: Average dwell time grouped by event name EventsBySession: Total events grouped by session AverageDwellBySession: Average dwell time grouped by session AverageEventsByNameAndSession: Average events grouped by event name and session

NetworkPingTotals: Total device pings including percetage of time active, downloading, and playing. Grouped by interval (day, week, month, hour, minute) NetworkAlertTotals: Totals alerts grouped by alert type and interval (day, week, month, hour, minute) NetworkAlertsByLocation: Alerts grouped by location

interval_type'Minute' | 'Hour' | 'Day' | 'Week' | 'Month'
device_idstring[] nullable

Array of devices by Id. REQUIRED

start_datestring date-time nullable

Report start date. REQUIRED

Provide in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

end_datestring date-time nullable

Report end date. REQUIRED

Provide in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

compare_start_timestring date-time nullable

Report start time.

Provide in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

compare_end_timestring date-time nullable

Report end time.

Provide in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Response

OK