Direct Sold API
Make a GET
request to the /maxDirectSoldReport
endpoint in this API to retrieve aggregated estimated statistics related to MAX mediation.
All times in the response are in UTC.
Request Format
Target URL
Parameters
Name | Description | Example |
---|---|---|
start 1 | The first day you want in the report, in «YYYY»-«MM»-«DD» «HH»:«MM»:«SS» or «YYYY»-«MM»-«DD» format. | start=2022-05-01 00:00:00 , start=2022-05-01 |
end 1 | The last day you want in the report, in in «YYYY»-«MM»-«DD» «HH»:«MM»:«SS» or «YYYY»-«MM»-«DD» format. | end=2022-05-03 00:00:00 , end=2022-05-03 |
api_key | Your 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,impressions |
filter_«x» | Filter column x to those with a specified value (see table of columns below). | filter_max_ad_unit_id=deb878533ea4e76a |
filter_not_«x» | Filter column x to exclude those with a specified value (see table of columns below). | filter_not_max_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 | Maximum 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 is returned. | offset=0 |
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 , or REWARD . | INTER |
ad_unit_waterfall_name | The name of the Ad Unit waterfall. | LAT |
application | Name of the application. | My App |
campaign | Name of the campaign | My Campaign |
campaign_id | Unique ID for the campaign | 524267 |
clicks | Number of clicks | 523 |
cost | Revenue generated in USD. Based on the value set in the campaign. | |
country | Two-letter ISO Country Code. | gb |
creative | Creative set name | My creative set |
creative_id | Unique ID for an ad creative | 524267 |
ctr | Click-through rate. The percentage of impressions that resulted in a click. | .23% |
day | Day of the data in «YYYY»-«MM»-«DD» format. | 2019-03-25 |
device_type | The user’s device type: phone , tablet , other . | phone |
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 |
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 |
order | Name of the order. | My Order |
order_id | Unique ID for an Order. | 524267 |
package_name | Package Name/Bundle ID of the application. | com.my.test.app |
platform | Platform of the application: android , fireos , or ios . | android |
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 is returned instead. | 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. For example:
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).