Use this endpoint to request all SDK Bidding data on your Tapdaq account.
If you group by app
, you will receive only application ID(s). If you need more information about a given application ID, you need to resolve the id using the Apps endpoint.
To access any endpoint on the Tapdaq Reporting API you need to include your authentication token which can be found on the Tapdaq dashboard. You can scroll to the examples section to see how it is used.
POST https://analytics.tapdaq.com/v1/reports/bidding
Name | * | Type | Description |
---|---|---|---|
start_time | required | YYYY-MM-DD |
Start date of report range |
end_time | required | YYYY-MM-DD |
End date of report range |
group_by | required | array[ date, app, ad_network, country, ad_unit, zone_key ] |
Define a breakdown of all the reports, at least one is required. |
app_ids | optional | array[ <app_id> ] |
Filter of included applications, if not defined, all applications from account are fetched if not included |
networks | optional | array[ adcolony, admob, applovin, chartboost, facebook, hyprmx, inmobi, ironsource, kiip, maio, mintegral, mopub, receptiv, tapjoy, tiktok, unityads, vungle, youappi, zplay ] |
Filter of included networks, all networks are included if not set |
ad_units | optional | array[ static_interstitial, video_interstitial, rewarded_video_interstitial, banner, native ] |
Filter of included ad units, all ad units are included if not set |
countries | optional | array[ gb, us, ... ] |
Filter of 2 digit country codes (ISO 3166-1 alpha-2) that are included in the report, if not set, all countries are selected |
For each unique group defined in a request, you will get an object in response array which is defined below. Please note that groups without any data are left out (omitted), so if you query last month with group_by =date, you don’t have to get a response object for each day in the selected range.
Name | Type | Description |
---|---|---|
[].group | Group that identifies the current data item. It can have one or more parameters listed below, depends on a group_by defined in request | |
[].group.app | STRING |
Application ID |
[].group.date | YYYY-MM-DD |
Date in YYYY-MM-DD format |
[].group.ad_unit | STRING |
Ad unit, available parameters are defined in request table |
[].group.ad_network | STRING |
Network, available parameters are defined in request table |
[].group.countries | CHAR(2) |
2-digit code of selected country in ISO 3166-1 alpha-2 |
--- | --- | --- |
[].auctions | INT |
The number of auctions held |
[].bid_requests | INT |
The total amount of requests made for a bid |
[].bid_responses | INT |
The total amount of times a bidder responds with a bid |
[].bid_price | MILLIDOLLAR |
The average bid price |
[].bid_win_rate | FLOAT |
The average number of auctions won per bid |
[].wins | INT |
The total amount of times a bidder won an auction |
[].win_price | MILLIDOLLAR |
The average bid price of the winning bid |
[].win_rate | FLOAT |
The average number of auctions won per request |
Use the examples below to gain a better understanding of how to use our Reporting API.
This request will break down the data for each application on your account, for each day in a given range.
curl --include \
--request POST \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <YOUR_API_TOKEN>" \
--data-binary "{
\"group_by\": [\"APP\", \"DATE\"],
\"start_time\": \"2019-10-08\",
\"end_time\": \"2017-10-10\"
}" \
'https://analytics.tapdaq.com/v1/reports/bidding'