Reporting API
此内容尚不支持你的语言。
Use this Reporting API to get aggregated campaign data in either JSON or CSV format.
Request Format
Make report requests by sending HTTP GET
requests to the following base URL:
https://r.applovin.com/report
Required Parameters
Parameters | Purpose |
---|---|
api_key | Your Report Key You can find this Report Key in the Keys tab of the account page in your AppLovin dashboard. |
start 1 | The start date of the report Accepts a date in YYYY-MM-DD format or a Unix timestamp. For example, 2012-10-05 or 1336608000 . |
end 1 | The end date of the report Accepts a date in YYYY-MM-DD format or a Unix timestamp. For example, 2012-10-05 or 1336608000 or now . |
format | The format for the report Accepts json or csv . See details on request format below. |
columns | A comma-separated list of columns for the report See the allowed columns below. For example, ad_id,day,campaign . |
report_type | advertiser (required) |
1 This API has a request window of 45 days. Make sure the date parameters are within the last 45 days.
Optional Parameters
Parameters | Purpose |
---|---|
day_column | Metrics are realtime by default; set this to day when you want to pull metrics under cohort (metrics are attributed back to serve time). |
limit | The limit on the number of rows returned; for example, 500 |
offset | The offset to begin fetching rows at; for example, 100 |
having | Allows complex filtering on numeric values. This parameter accepts URL-encoded values of numeric columns, comparison operators, and logical operators, for example: impressions%20%3E%200%20AND%20cost%20%3E%200 (“impressions > 0 AND cost > 0”).Note: This slows down the response and increases the likelihood of timeouts. |
not_zero | Set this to 1 to filter results in which all numerical metrics have a value of 0. |
Recommended Columns
Column Name | Contains |
---|---|
ad | Ad name |
ad_id | Ad ID. This does not change if the ad name changes. |
campaign | Campaign name |
campaign_id_external | Unique reference to a campaign This does not change when the campaign is renamed. It is the same value as the {CAMPAIGN_ID} click macro. |
cost | Advertiser spend |
country | Two letter country code |
creative_set | Creative set name |
creative_set_id | Creative set ID. This does not change if the creative set name changes. |
day | Date of reporting data |
hour | Hour of reporting data (only available for the past 30 days) |
Optional Columns
Column Name | Contains |
---|---|
ad_creative_type | GRAPHIC , PLAYABLE , VIDEO , or VIDEO_PLAYABLE |
ad_type | APPOPEN , GRAPHIC , PLAY , REWARD , or VIDEO |
average_cpc | Average cost per click |
campaign_bid_goal | The campaign bid goal, expressed as a dollar value ($), for CPP and CPE campaigns. You must also request the campaign column when you request this one. |
chka_0d | Attributed checkouts that occurred within 24 hours since the impression time |
chka_1d | Attributed checkouts that occurred within 48 hours since the impression time |
chka_2d | Attributed checkouts that occurred within 72 hours since the impression time |
chka_3d | Attributed checkouts that occurred within 96 hours since the impression time |
chka_7d | Attributed checkouts that occurred within 192 hours since the impression time |
chka_usd_0d | Total attributed checkout revenue that occurred within 24 hours since the impression time |
chka_usd_1d | Total attributed checkout revenue that occurred within 48 hours since the impression time |
chka_usd_2d | Total attributed checkout revenue that occurred within 72 hours since the impression time |
chka_usd_3d | Total attributed checkout revenue that occurred within 96 hours since the impression time |
chka_usd_7d | Total attributed checkout revenue that occurred within 192 hours since the impression time |
clicks | Number of clicks |
cost_per_chka_0d | CPP within 24 hours since the impression time |
cost_per_chka_1d | CPP within 48 hours since the impression time |
cost_per_chka_2d | CPP within 72 hours since the impression time |
cost_per_chka_3d | CPP within 96 hours since the impression time |
cost_per_chka_7d | CPP within 192 hours since the impression time |
ctr | Number of clicks ÷ number of impressions |
custom_page_id | The specific landing page |
impressions | Number of impressions |
placement_type | APP_OPEN , ARRAY , BANNER , CTV , INTER , LEADER , MREC , NATIVE , or REWARDED_INTER |
platform | android , ios , fireos , or tvos |
roas_0d | Checkout ROAS generated within 24 hours since the impression time |
roas_1d | Checkout ROAS generated within 48 hours since the impression time |
roas_2d | Checkout ROAS generated within 72 hours since the impression time |
roas_3d | Checkout ROAS generated within 96 hours since the impression time |
roas_7d | Checkout ROAS generated within 192 hours since the impression time |
sales | Count of attributed sales events |
size | Ad size (BANNER , INTER , LEADER , MREC , NATIVE , or PRELOAD ) |
Filtering Columns
You can filter reports by any column. When you do so, you search for a direct match to any of the filters.
To filter by a column, add the following URL parameter: filter_columnname=onefilter,anotherfilter,thirdfilter
For example, if you want to see data only for the Android platform, set the following URL parameter: filter_platform=Android
See the table above for a list of all columns.
Some columns support negative filters via filter_not_columnname=onefilter,anotherfilter
.
Additionally, the custom_page_id
column supports filter_null_custom_page_id
, filter_blank_custom_page_id
, filter_not_null_custom_page_id
, and filter_not_blank_custom_page_id
options.
These options do not require a value, i.e. …&filter_not_null_custom_page_id=&filter_not_blank_custom_page_id=&…
Sorting Columns
You sort reports in a similar way to how you filter reports.
For example, to sort a report by campaign
, add the following URL parameter: sort_campaign=ASC
The accepted values are ASC
for ascending or DESC
for descending.
All sorts are lexicographical sort.
Report Formats
You can request reports in two formats: JSON or CSV.
Time Zone
All data in the reporting API is in UTC (Coordinated Universal Time).