Skip to content

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


startThe 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
endThe 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_keyYour Report Key.api_key=Hyfi8Mkct…WiWP466a1VBL7eUfUlD9JBh
formatResponse format: csv or json.format=csv
columnsWhich 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
limitMaximum number of results to return. Use this together with offset to paginate API requests that have a large number of results.limit=1000
offsetHow 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

This API has a request window of 45 days. Make sure the date parameters are within the last 45 days.


ad_formatAd unit ad type: INTER, BANNER, or REWARD.INTER
ad_unit_waterfall_nameThe name of the Ad Unit waterfall.LAT
applicationName of the application.My App
campaignName of the campaignMy Campaign
campaign_idUnique ID for the campaign524267
clicksNumber of clicks523
costRevenue generated in USD. Based on the value set in the campaign.
countryTwo-letter ISO Country
creativeCreative set nameMy creative set
creative_idUnique ID for an ad creative524267
ctrClick-through rate. The percentage of impressions that resulted in a click..23%
dayDay of the data in «YYYY»-«MM»-«DD» format.2019-03-25
device_typeThe user’s device type: phone, tablet,
has_idfaDoes 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
impressionsNumber of impressions shown.28942
max_ad_unitMAX Ad Unit name.Solitaire Rewarded
max_ad_unit_idMAX Ad Unit ID.deb878533ea4e76a
max_ad_unit_testMAX Ad Unit test group name (if applicable).Control
orderName of the order.My Order
order_idUnique ID for an Order.524267
package_namePackage Name/Bundle ID of the
platformPlatform of the application: android, fireos, or
store_idThe 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:

2022-05-01 00:00:00,five hoops,1,2,2.000000000000,phone,0.005000000000,0,ios,1484825317
2022-05-01 00:00:00,flip dunk,1,0,0.000000000000,phone,0.005000000000,0,ios,1459811607
2022-05-01 00:00:00,jump dunk 3d,1,0,0.000000000000,phone,0.005000000000,0,ios,1531856776
2022-05-01 00:00:00,run of life,1,0,0.000000000000,phone,0.005000000000,0,ios,1558155715
2022-05-01 00:00:00,woodturning,1,0,0.000000000000,phone,0.005000000000,0,ios,1492451796
2022-05-01 00:00:00,dunk hit,1,0,0.000000000000,phone,0.005000000000,1,ios,1265145322
2022-05-01 00:00:00,flip dunk,1,0,0.000000000000,phone,0.005000000000,1,ios,1459811607
2022-05-01 00:00:00,jump dunk 3d,1,0,0.000000000000,phone,0.005000000000,1,ios,1531856776
2022-05-01 00:00:00,woodturning,1,0,0.000000000000,phone,0.005000000000,1,ios,1492451796