AppLovin Revenue Reporting API
Note that data generated by third-party data integration counts toward the cluster's data consumption
Summary
Interface overview
| Interface | Type | Granularity | Attribution | Cost | Revenue | Impressions | Clicks | Conversions |
|---|---|---|---|---|---|---|---|---|
| Revenue Reporting API | API | Aggregated data | ✅ | ✅ |
AppLovin also provides an aggregated metrics API dedicated to Max monetization: the Revenue Reporting API.
Integration process
- Log in to the AppLovin dashboard and get the Report Key
- Log in to the AE backend, go to the Third-party Integration module, add an AppLovin Revenue Reporting API plan, and complete the related configuration
- Check whether the AE system receives the data successfully, and build reports
1. Get the Report Key
To connect AppLovin Revenue Reporting API data, you need to get the Report Key first. Log in to the AppLovin dashboard and get the Report Key under Account > Key. Keep this key safe
2. Plan configuration
After you get the Report Key, log in to the AE system and configure the new plan in the Third-party Integration module. The image below shows the configuration page of AppLovin Revenue Reporting API. Follow this section to create the plan:
2.1 Authorization information configuration
Click the Configure authorization information button under Authorization Information, and enter the information you obtained during authorization in the pop-up
API Key is the Report Key you just obtained. By default, you cannot enter the API Key directly in the pop-up. Click the edit icon on the right first, and then enter it.
2.2 Sync Schedule
In the Sync Schedule module, you can set the policy for the AE system to pull AppLovin Revenue Reporting API data on a schedule. You can choose to pull data for a period of time at a specific time every day or every hour.
2.3 Event Data Configuration
After you turn on the Event Data Configuration switch, all data sent back is written to the event table. We recommend that you enable event data ingestion.
2.4 Configuration
In the Configuration module, you can control the detailed settings of data pulling, including the time aggregation granularity of the data, the metric fields and dimensions to pull, and the event name after ingestion.
The content of the configuration is a JSON, which you can customize as follows:
| Module | Name | Description |
|---|---|---|
| sink_event | event_name | Event name after ingestion; customizable |
| source | metrics | Metrics in the data; list type. Different levels support different metrics, so fill this in carefully |
| group_by | Grouping dimensions in the data; list type. Different levels support different group_by values, so fill this in carefully |
- Grouping dimensions
The following are the supported group-by dimensions. To adjust them, modify source.group_by
| Field | Default | Description |
|---|---|---|
| day | Yes | Date of the ad impression |
| hour | Yes | Hour value of the report (this field exists only when you pull data for the last 30 days) |
| has_idfa | Yes | Whether the user's advertising ID can be obtained. The value is 0 if the user has enabled LAT or has turned off data tracking in a region where GDPR applies; otherwise, it is 1 |
| max_ad_unit | Yes | MAX ad name |
| max_ad_unit_id | Yes | MAX ad ID |
| max_ad_unit_test | Yes | Name of the ad test group |
| network_placement | Yes | Placement name of the Ad Network |
| max_placement | Placement name customized in the SDK | |
| network | Yes | The Ad Network that displayed the ad. For possible values, see (MAX Mediation Documentation) |
| package_name | Yes | Package name: the App Package Name on Android and the Bundle ID (iOS) on iOS |
| platform | Yes | Platform |
| ad_format | Yes | Ad type: INTER, BANNER, REWARD |
| ad_unit_waterfall_name | Yes | Name of the ad Waterfall |
| application | Yes | App name |
| country | Yes | Two-letter Country Code |
| custom_network_name | Yes | Custom Ad Network name |
| device_type | Yes | Device type: PHONE, TABLET |
| store_id | App store ID of the promoted app: package name on Android, numeric part of the iTunes ID on iOS |
- Metric fields
The following are the supported metric fields. To adjust them, modify source.metrics
| Field | Default | Description |
|---|---|---|
| impressions | Yes | Number of ad impressions |
| estimated_revenue | Yes | Estimated total revenue (USD) |
| attempts | Yes | Number of ad attempts on the Ad Network (available only when network or network_placement is among the group-by fields to pull; unavailable when max_placement is present) |
| ecpm | Yes | Estimated eCPM (USD) |
fill_rate | Yes | Ad fill rate = ad responses / attempts (available only when network or network_placement is among the group-by fields to pull; unavailable when max_placement is present) |
| responses | Yes | Number of ad responses (available only when network or network_placement is among the group-by fields to pull; unavailable when max_placement is present) |
| requests | Number of ad requests (unavailable when network, network_placement, or max_placement is present) |
2.5 Data ingestion rules
By default, we write the pulled data to the AE project as events:
- When the hour field does not exist (that is, for data older than 30 days), the day field in the data, that is, the date of the data, is set as the #event_time of the aggregated data. When hour exists, the day and hour fields are combined into the #event_time of the aggregated data
- The event name is applovin_maxreport
- All other fields are stored
2.6 Standardized fields
The following event properties are standardized:
| Original field | Standardized field | Description |
|---|---|---|
| max_ad_unit | te_ads_object.ad_group_name | Unit name of the monetization ad |
| max_ad_unit_id | te_ads_object.ad_group_id | Unit ID of the monetization ad |
| network_placement | te_ads_object.placement | Ad placement |
| network | te_ads_object.media_source | Media source or monetization channel |
| package_name | te_ads_object.app_id | App ID |
| application | te_ads_object.app_name | App name |
| platform | te_ads_object.platform | Platform, such as Android or iOS |
| country | te_ads_object.country | Country or region code |
| Fixed value USD | te_ads_object.currency | Currency of the monetization revenue |
| impressions | te_ads_object.impressions | Impressions |
| estimated_revenue | te_ads_object.revenue | Monetization revenue |