You can only make HTTPS requests to the endpoint in this API. You will get a redirect (308) response code rather than the response you expect if you use HTTP instead.
Make a GET request to the /maxReport endpoint in this API to retrieve aggregated estimated statistics related to MAX mediation. All times shown in the response are in UTC.
You must authenticate this request. To do so, set the value of api_key in your request payload to your account’s Report Key.
Request Format
Target URL
https://r.applovin.com/maxReport
Parameters
Name | Description | Example |
---|---|---|
* This API has a request window of 45 days. Make sure the date parameters are within the last 45 days. | ||
start* | The first day you want in the report, in YYYY-MM-DD format. | start=2019-03-25 |
end* | The last day you want in the report. | end=2019-03-29 |
api_key | Your API Report Key. | api_key=Hyfi8Mkct…WiWP466a1VBL7eUfUlD9JBh |
format | Response format: csv or json. | format=csv |
columns | Which columns you want reported (see table of columns below). Comma-separated. | columns=day,application,ecpm |
filter_x | Filter column x by a value (see table of columns below). | filter_ad_unit_id=deb878533ea4e76a |
sort_x | Sort the response by column x (see table of columns below). You can add multiple sorts with multiple sort_x parameters, and these will execute in the order in which the parameters appear in the query string. ASC (ascending) or DESC (descending). | sort_impressions=DESC |
limit | Number of results to return. Use this together with offset to paginate API requests that have a large number of results. | limit=1000 |
offset | How many entries to skip before returning results. If the value is larger than the total number of entries, an empty set will be returned. | offset=0 |
Columns
Name | Description | Example |
---|---|---|
ad_format | Ad unit ad type: INTER, BANNER, REWARD. | INTER |
ad_unit_waterfall_name | The name of the Ad Unit Waterfall. | LAT |
application | Name of the application. | My App |
attempts | Number of attempts made to an ad network (can only be shown if you group by network and/or network_placement; cannot be shown if you group by max_placement). | 41734 |
country | Two-letter ISO Country Code. | gb |
custom_network_name | Custom network name or Direct Sold campaign name. | Custom Network |
day | Day of the data in YYYY-MM-DD format. | 2019-03-25 |
device_type | The user’s device type: phone, tablet, other. | phone |
ecpm | Estimated eCPM generated in USD. | 8.47 |
estimated_revenue | Estimated revenue generated in USD. | 245.12 |
fill_rate | responses / attempts (can only be shown if you group by network and/or network_placement; cannot be shown if you group by max_placement). | .8512 |
has_idfa | Does the user have an ad ID available. 0 if the user enabled LAT (Limit Ad Traffic) or opted out of data usage in GDPR geos, otherwise 1. | 0 |
hour | Hour of the data (only for dates within the last 30 days). | 20:00 |
impressions | Number of impressions shown. | 28942 |
max_ad_unit | MAX Ad Unit name. | Solitaire Rewarded |
max_ad_unit_id | MAX Ad Unit ID. | deb878533ea4e76a |
max_ad_unit_test | MAX Ad Unit test group name (if applicable). | Control |
max_placement | MAX mediation placement name (if applicable). | launch_screen |
network | Ad network name. | AppLovin |
network_placement | Placement of the external Ad Network. | ca-app-pub-12345678/0987654321 |
package_name | Package Name/Bundle ID of the application. | com.my.test.app |
platform | Platform of the application: android, fireos, or ios. | android |
requests | Number of ad requests (cannot be shown if you group by network, network_placement, or max_placement). | 45651 |
responses | Number of responses from an ad network (can only be shown if you group by network and/or network_placement; cannot be shown if you group by max_placement). | 39841 |
store_id | The numeric portion of the iTunes ID on iOS, or the app’s package name on Android. If the iTunes ID is not known to AppLovin, the Bundle ID will be returned instead. | 1207472156 |
Response Format
-
If the request includes format=csv, the response will be a comma-separated text file with the column heading in the same order as indicated in the columns parameter:
day,hour,application,impressions 2019-03-25,00:00,"My Test App",987654 2019-03-25,01:00,"My Test App",819127
-
If the request includes format=json, the response will be a JSON file with keys code (response code; 200 means successful), count (the number of results returned), and results (a list of dictionaries with data):
{ "code": 200, "results": [ { "day": "2019-03-25", "hour": "00:00", "application": "My Test App", "impressions": "987654" }, { "day": "2019-03-25", "hour": "01:00", "application": "My Test App", "impressions": "819127" } ], "count": 2 }