User-Level Ad Revenue API
© 2025 AppLovin. All rights reserved.
import AccordionItem from "/src/components/AccordionItem.astro";
The following code snippets show you how to add custom String data to postbacks.
This String data replaces the {CUSTOM_DATA} macro in these postbacks.
AppLovin recommends that your string contain fewer than 8192 characters.
Use this API to retrieve user-level revenue data. You can retrieve this data aggregated for a particular user or with one row per impression.
User-level revenue data is available eight hours after UTC day end. For example, data for UTC 2019‒01‒01 is available on UTC 2019‒01‒02 after 08:00.
You can share user-level and impression-level ad revenue data with your mobile measurement partner of choice, such as Adjust, AppsFlyer, GameAnalytics or Singular, for all supported networks. You can also access impression-level user revenue data on the client side. You can read more about this in SDK integration guides > Platform > Overview > Advanced settings.
MAX posts data to a tracking URL of your choosing, whenever it records a MAX impression, with a Server-to-Server Impression Revenue API. See the S2S impression revenue API documentation page for more information.
| Name | Description | Example |
|---|---|---|
aggregated | Whether the API should aggregate the data (per user) or not (per impression). Defaults to true. | false |
api_key | Report Key, for authentication. | tgCe3d7SFRU0S…304ZKs6ba |
application | Application package name (for Android) or bundle ID (for iOS). (You cannot use this parameter if you define store_id) | com.mycompany.application |
date1 | Day to return data for, in «YYYY»-«MM»-«DD» format. | 2019-02-06 |
platform | Application platform: android, fireos, or ios. | android |
store_id | The numeric part of the iTunes ID on iOS, or the app’s package name on Android. If you do not know the iTunes ID, use the bundle ID instead. You cannot use this parameter if you define application. | 1207472156 |
1 This API has a request window of 45 days. Make sure the date parameters are in the last 45 days.
| Name | Description |
|---|---|
ad_revenue_report_url | Location of the CSV file with all revenue including estimated Meta Audience Network Bidding data. |
fb_estimated_revenue_url | Location of the CSV file with only estimated Meta Audience Network Bidding data. Please note that these numbers may differ from actuals since Meta Audience Network Bidding data is calculated using estimated revenue data. This option is only available on aggregated requests. |
status | Status of the request: 200 if a user report can be accessed. |
url | Location of the CSV file that excludes estimated Meta Bidding data. |
| Name | Description |
|---|---|
Ad Format | INTER, BANNER, REWARD (Non-Aggregated only). |
Ad Placement | The placement ID of the external ad network that showed the ad (Non-Aggregated only). |
Ad Unit ID | ID of the MAX Ad Unit that generated the revenue. |
Ad Unit Name | Name of the MAX Ad Unit that generated the revenue (Non-Aggregated only). |
Country | The two-letter country code of the impression (Non-Aggregated only). |
Custom Data | Custom data passed in from the integration. |
Date | Time of the impression (Non-Aggregated only). |
Device Type | PHONE, TABLET (Non-Aggregated only). |
IDFA | Advertising identifier: IDFA for iOS devices, GAID for Android devices. |
IDFV | Identifier for vendor. |
Impressions | The number of ads displayed to the user (Aggregated only). |
Network | The Ad Network that generated the impression. You can find Ad Network values in the “Network API Name” column of this table. (Non-Aggregated ad_revenue_report_url only) |
Placement | The Ad Placement Name where the user generated impressions and revenue. |
Revenue | The revenue generated by the user, in USD, expressed with six-decimal precision. |
User ID | Optional ID of the user, set via the AppLovin SDK. (See the “Setting an internal user ID” section below.) |
Waterfall | MAX ad unit waterfall name (Non-Aggregated only). |
import AccordionItem from "/src/components/AccordionItem.astro";
The following code snippets show you how you can add a placement name to an ad unit.
The value of the placement name replaces the {PLACEMENT} macro in postback requests:
The following code snippets show how to tag users with your own internal User ID. The maximum size of the User ID string is 8192 characters.
You must set custom data before you load a banner ad or MREC ad. Otherwise that data will not appear in the postbacks associated with the ad.
[COMPONENT: NativeAdView]
“Take Ad-Revenue Attribution to the Next Level With MAX” from AppLovin’s Blog
You must authenticate to use this API.
To do so, set the value of the URL parameter api_key to your Report Key.
[COMPONENT: AdView]
[COMPONENT: AdView]
[COMPONENT: NativeAdView]
