Web Reporting API
Use this Reporting API to get aggregated web campaign data in either JSON or CSV format.
This endpoint allows you to specify the attribution mode.
Request format
Make report requests by sending HTTP GET requests to the following base URL:
https://r.applovin.com/webReport
Required parameters
| Parameters | Purpose |
|---|---|
api_key | Your Report Key You can find your Report Key on the AppLovin dashboard by clicking your account in the top right of the dashboard and selecting Keys. |
start1 | 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. |
end1 | 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. |
columns | A comma-separated list of columns for the report See the allowed columns below. For example, day,campaign. |
report_type | advertiser (required) |
attribution_mode | The attribution mode for the report Accepts click (click-through attribution only) or click_and_view (click-through and view-through attribution). |
1 This API has a request window of 90 days. Make sure the date parameters are in the last 90 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 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 |
|---|---|
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_id | Ad ID |
audience_strategy | The campaign audience optimization strategy (universal, prospecting, or discovery) |
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. |
campaign_type | The campaign optimization type (CPP, CPE, or ROAS) |
chka_usd_«x»1 | Total attributed checkout revenue during a particular time span («x» is one of 0d, 1d, 3d, 7d, 14d, 28d) |
clicks | Number of clicks |
cpp_«x»1 | Cost per purchase during a particular time span («x» is one of 0d, 1d, 3d, 7d, 14d, 28d) |
ctr | Number of clicks ÷ number of impressions |
impressions | Number of impressions |
optimization_day_target | Which optimization day you chose to target for the campaign (for example, day 0 or day 7) |
placement_type | INTER or REWARDED_INTER |
platform | android, ios, fireos, or tvos |
roas_«x»1 | Total ROAS during a particular time span («x» is one of 0d, 1d, 3d, 7d, 14d, 28d) |
sales | Count of attributed sales events |
sales_«x»1 | Sales during a particular time span («x» is one of 0d, 1d, 3d, 7d, 14d, 28d) |
1Time periods are specified as rolling windows from impression time. 0d means events in the 24 hours since the impression time, 1d 48 hours, 3d 96 hours, etc.
New customer data columns
| Column name | Contains |
|---|---|
nc_d0_checkouts | Number of checkouts made by new customers in the 24 hours since the impression. |
nc_d0_checkout_rev | Total revenue from new customers measured in the 24 hours since the impression. |
nc_d0_cpp | Spend divided by new customer D0 checkouts. |
nc_d0_roas | New customer D0 checkout revenue divided by spend. |
nc_percent_d0_checkouts | Percentage of D0 checkouts generated by new customers. |
nc_percent_d0_checkout_rev | Percentage of D0 checkout revenue generated by new customers. |
nc_d7_checkouts | Number of checkouts made by new customers in the 192 hours since the impression. |
nc_d7_checkout_rev | Total revenue from new customers measured in the 192 hours since the impression. |
nc_d7_cpp | Spend divided by new customer D7 checkouts. |
nc_d7_roas | New customer D7 checkout revenue divided by spend. |
nc_percent_d7_checkouts | Percentage of D7 checkouts generated by new customers. |
nc_percent_d7_checkout_rev | Percentage of D7 checkout revenue generated by new customers. |
new_visitor_rate | Percentage of visits to your website that are from new visitors. |
CPE columns
| Column name | Contains |
|---|---|
cost_per_target_event_0d | Spend divided by the number of targeted events in the 24 hours since the impression. |
target_event | Name of the event the campaign optimizes towards. |
target_event_count_0d | Number of targeted events triggered by customers in the 24 hours since the impression. |
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».
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).
Example request
https://r.applovin.com/webReport?api_key=«your-report-key»&start=2024-04-20&end=now&columns=day,campaign,impressions,clicks,ctr,cost,sales&format=json&report_type=advertiser&attribution_mode=click
Cookie Settings