Moloco Report 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 |
|---|---|---|---|---|---|---|---|---|
| Report API | API | Aggregated metrics | ✅ | ✅ | ✅ | ✅ | ✅ |
Report API is an aggregated data API. It returns metric data for a period of time, including cost, revenue, impression, click, and conversion data
Integration process
- Log in to your Moloco account and create an API Key
- Log in to the AE backend, go to the Third-party Integration module, add a Moloco Report API plan, and complete the related configuration
- Check whether the AE system receives the data successfully, and build reports
1. Get information from the Moloco backend
1.1 Get the API Key
Before calling the API, you need to get an API Key. Log in to your Moloco account and find the API Access section in the user settings menu in the upper-right corner.
Next, click Create API Key to create a new Moloco API Key. If you have created an API Key before, you can also use the existing one. Make sure to keep the value of the API Key.
1.2 Get the ad account ID
Next, get the IDs of all the ad accounts you want to pull data from. You can get the ad account ID as shown in the image below. Because you can configure multiple ad accounts, we recommend getting the IDs of all the ad accounts you want to pull data from
2. Plan configuration
After you get the Moloco authorization information, you can log in to the AE system backend and configure Moloco Report API in the Third-party Integration module. The image below shows the Moloco configuration page:
2.1 Authorization information configuration
Click the Configure authorization information button under Authorization Information and enter the information you got from the Moloco backend in the pop-up
- API Key: enter the API Key you created in Moloco
- Ad Account ID: the IDs of the ad accounts you want to pull data from. Separate multiple IDs with ","
2.2 Sync Schedule
In the Sync Schedule module, you can set the policy for the AE system to pull Moloco Report 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. Because pulled data also counts toward the data volume, avoid pulling data for overly long periods on a schedule
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 details of data pulling, such as the event name after ingestion and the dimensions of the pulled data.
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 | group_by | Grouping dimensions in the data; list type |
| transfer | double_columns | Ingested metric fields. Do not modify |
- Grouping dimensions
The following are the supported grouping dimensions. By default, we get data for all dimensions. Each dimension corresponds to multiple ingestion fields, as shown in the table below. To make changes, modify source.group_by and enter the names of the grouping dimensions you want to pull
| Dimension | Ingested field name | Default | Description |
|---|---|---|---|
| Included by default | ad_account_currency | Yes | Currency used by the ad account |
| ad_account_id | Yes | Ad account ID | |
| ad_account_title | Yes | Ad account name | |
| DATE | date | Yes | Date |
| APP_OR_SITE | app_id | Yes | Unique app ID |
| app_os | Yes | Platform of the app | |
| app_store_id | Yes | App store ID | |
| app_title | Yes | App name | |
| site_domain | Yes | Site domain | |
| site_id | Yes | Site ID | |
| site_title | Yes | Site name | |
CAMPAIGN | campaign_country | Yes | Country or region of the campaign |
| campaign_id | Yes | Campaign ID | |
| campaign_title | Yes | Campaign name | |
| AD_GROUP | ad_group_id | Yes | Ad group ID |
| ad_group_title | Yes | Ad group name | |
| CREATIVE_GROUP | creative_group_id | Yes | Creative group ID |
| creative_group_title | Yes | Creative group name | |
CREATIVE | creative_id | Yes | Asset ID |
| creative_main_asset_location | Yes | Creative asset URL | |
| creative_title | Yes | Creative name | |
| creative_type | Yes | Creative type | |
| EXCHANGE | exchange_id | Yes | Unique exchange ID |
SUB_PUBLISHER | sub_publisher_id | Yes | Sub Publisher ID |
| sub_publisher_title | Yes | Sub Publisher name | |
| TRAFFIC | traffic_is_lat | Yes | Whether LAT is enabled (Boolean) |
| traffic_mmp_effective | Yes | Whether it can be attributed | |
| traffic_skan_bid | Yes | Whether it includes a SKAN response |
- Metric fields
The following are the supported metric fields:
| Field | Description |
|---|---|
| impressions | Impressions |
| clicks | Clicks |
| installs | Installs |
| spend | User acquisition cost |
| revenue | Monetization revenue |
2.5 Ingestion rules
- The date field in the data, that is, the date of the data, is set as the #event_time of the aggregated data
- The default event name for Report API data is: moloco_report
- All other fields are stored
2.6 Standardized fields
The following event properties are standardized:
| Original field | Standardized field | Description |
|---|---|---|
| ad_account_id | te_ads_object.ad_account_id | Ad account ID |
| campaign_title | te_ads_object.campaign_name | Campaign name |
| campaign_id | te_ads_object.campaign_id | Campaign ID |
| ad_group_title | te_ads_object.ad_group_name | Ad group name, or the Unit name for monetization ads |
| ad_group_id | te_ads_object.ad_group_id | Ad group ID, or the Unit ID for monetization ads |
| creative_group_title | te_ads_object.ad_name | Ad name |
| creative_group_id | te_ads_object.ad_id | Ad ID |
| app_store_id | te_ads_object.app_id | App ID |
| app_title | te_ads_object.app_name | App name |
| app_os | te_ads_object.platform | Platform, such as Android or iOS |
| campaign_country | te_ads_object.country | Country or region code |
| ad_account_currency | te_ads_object.currency | Currency of the cost or revenue |
| impressions | te_ads_object.impressions | Impressions |
| clicks | te_ads_object.clicks | Clicks |
| installs | te_ads_object.installs | Conversions (installs) |
| spend | te_ads_object.cost | User acquisition cost |
| revenue | te_ads_object.revenue | Monetization revenue |

