Revenue Reporting API
Use this API to retrieve aggregated estimated statistics related to MAX mediation. All times shown in the response are in UTC.
Request Format
Target URL
https://r.applovin.com/maxReport
Parameters
Name | Description | Example |
---|---|---|
api_key | Your Report Key. | api_key=Hyfi8Mkct…WiWP466a1VBL7eUfUlD9JBh |
columns | Which columns you want reported (see table of columns below). Comma-separated. | columns=day,application,ecpm |
end 1 | The last day you want in the report, in «YYYY»-«MM»-«DD» format. | end=2019-03-29 |
filter_«x» | Filter column «x» by a value (see table of columns below). | filter_max_ad_unit_id=deb878533ea4e76a |
format | Response format: csv or json . | format=csv |
limit | Number of results to return. Use this together with offset to paginate API requests that have a large number of results. | limit=1000 |
not_zero | Set to 1 to filter results in which all numerical metrics have a value of 0. | not_zero=1 |
offset | How many entries to skip before returning results. If the value is larger than the total number of entries, this endpoint returns an empty set. | offset=0 |
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 |
start 1 | The first day you want in the report, in «YYYY»-«MM»-«DD» format. | start=2019-03-25 |
1 This API has a request window of 45 days. Make sure the date parameters are within the last 45 days.
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 (only shows if you include the column network and/or network_placement ; cannot show if you include column max_placement ). | 41734 |
country | Two-letter ISO Country Code. | gb |
custom_network_name | Custom network 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 show if you include column network and/or network_placement ; cannot show if you include column 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_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 show if you include column network , network_placement , or max_placement ). | 45651 |
responses | Number of responses from an ad network (can only show if you include column network and/or network_placement ; cannot show if you include column max_placement ). | 39841 |
store_id | The numeric part of the iTunes ID on iOS, or the app’s package name on Android. If the iTunes ID is not known to AppLovin, this is the Bundle ID. | 1207472156 |
Response Format
If the request includes format=csv
, the response is a comma-separated text file with the column heading in the same order as indicated in the columns
parameter:
day,hour,application,impressions2019-03-25,00:00,"My Test App",9876542019-03-25,01:00,"My Test App",819127
If the request includes format=json
, the response is 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}