Direct Sold API

  • Updated

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.

You must authenticate to use these endpoints. To do so, set the value of api_key in your request to your account’s Reports Key.

Request Format

Target URL

https://r.applovin.com/maxDirectSoldReport

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 HH:MM:SS or YYYY-MM-DD format. start=2022-05-01 00:00:00, start=2022-05-01
end* 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 API Report Key. api_key=Hyfi8Mkct…WiWP466a1VBL7eUfUlD9JBh
format Response format: csv or json. format=csv
columns Which columns you want reported (see below). Comma-separated. columns=day,application,impressions
filter_x Filter column x to those with a specified value (see table of columns below). filter_ad_unit_id=deb878533ea4e76a
filter_not_x Filter column x to exclude those with a specified value (see table of columns below). filter_not_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 will be returned. offset=0

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 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. For example:

    day,application,impressions,clicks,ctr,device_type,cost,has_idfa,platform,store_id
    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
  • 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).

    {
      "results": [
        {
          "day": "2022-05-01 00:00:00",
          "application": "five hoops",
          "impressions": "1",
          "clicks": "2",
          "ctr": "2.000000000000",
          "device_type": "phone",
          "cost": "0.005000000000",
          "has_idfa": "0",
          "platform": "ios",
          "store_id": "1484825317"
        },
        {
          "day": "2022-05-01 00:00:00",
          "application": "flip dunk",
          "impressions": "1",
          "clicks": "0",
          "ctr": "0.000000000000",
          "device_type": "phone",
          "cost": "0.005000000000",
          "has_idfa": "0",
          "platform": "ios",
          "store_id": "1459811607"
        },
        {
          "day": "2022-05-01 00:00:00",
          "application": "jump dunk 3d",
          "impressions": "1",
          "clicks": "0",
          "ctr": "0.000000000000",
          "device_type": "phone",
          "cost": "0.005000000000",
          "has_idfa": "0",
          "platform": "ios",
          "store_id": "1531856776"
        },
        {
          "day": "2022-05-01 00:00:00",
          "application": "run of life",
          "impressions": "1",
          "clicks": "0",
          "ctr": "0.000000000000",
          "device_type": "phone",
          "cost": "0.005000000000",
          "has_idfa": "0",
          "platform": "ios",
          "store_id": "1558155715"
        },
        {
          "day": "2022-05-01 00:00:00",
          "application": "woodturning",
          "impressions": "1",
          "clicks": "0",
          "ctr": "0.000000000000",
          "device_type": "phone",
          "cost": "0.005000000000",
          "has_idfa": "0",
          "platform": "ios",
          "store_id": "1492451796"
        },
        {
          "day": "2022-05-01 00:00:00",
          "application": "dunk hit",
          "impressions": "1",
          "clicks": "0",
          "ctr": "0.000000000000",
          "device_type": "phone",
          "cost": "0.005000000000",
          "has_idfa": "1",
          "platform": "ios",
          "store_id": "1265145322"
        },
        {
          "day": "2022-05-01 00:00:00",
          "application": "flip dunk",
          "impressions": "1",
          "clicks": "0",
          "ctr": "0.000000000000",
          "device_type": "phone",
          "cost": "0.005000000000",
          "has_idfa": "1",
          "platform": "ios",
          "store_id": "1459811607"
        },
        {
          "day": "2022-05-01 00:00:00",
          "application": "jump dunk 3d",
          "impressions": "1",
          "clicks": "0",
          "ctr": "0.000000000000",
          "device_type": "phone",
          "cost": "0.005000000000",
          "has_idfa": "1",
          "platform": "ios",
          "store_id": "1531856776"
        },
        {
          "day": "2022-05-01 00:00:00",
          "application": "woodturning",
          "impressions": "1",
          "clicks": "0",
          "ctr": "0.000000000000",
          "device_type": "phone",
          "cost": "0.005000000000",
          "has_idfa": "1",
          "platform": "ios",
          "store_id": "1492451796"
        }
      ],
      "code": 200,
      "count": 9
    }