AppsFlyer's new customizable aggregated data API allows you to create your own report containing Lifetime Value (LTV), Retention and Activity-based KPIs, for either one or all of your apps. In addition, you can define the different groups according to which you want to view the data. The data is available in either CSV or JSON formats.
To use the API, compose the URL which defines the data that you want to view.
Master API is an AppsFlyer premium feature.
API Endpoint
Every call to the Master Report API must begin with the following endpoint:
https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]&app_id=[app_id]&from=[from_date]&to=[to_date]
All the received fields in the response are according to V5 format.
By default, the response data is received in CSV file format. If you prefer to get the data in JSON format add "&format=json" to the URL.
Additional Parameters
|
Parameter |
Description |
Example |
Mandatory? |
|
api_token |
API token as appears under the API Access page in the dashboard |
123510e9-1111-2222-3333-123bd8eeca9f |
Yes |
|
from |
Start date |
2016-08-02 |
Yes |
|
to |
End date |
2016-08-08 |
Yes |
|
app_id |
Represents the apps included in the reports. Either comma separated or "all". |
app_id=app_id1,app_id2 app_id=all |
Yes |
|
groupings |
comma separated, representing the different group by parameters for the selected query |
groupings=pid,geo |
Yes |
|
kpis |
comma separated – See below |
kpis=installs,click, impressions,sessions,retention_day_7 |
Yes |
|
pid |
Used for filtering the media source name, comma separated multiple selection is supported |
pid=organic, applovin_int |
No |
|
c |
Used for filtering by campaign name, comma separated multiple selection is supported |
c=my_sample_campaign |
No |
|
af_prt |
Used for filtering by agency name, comma separated multiple selection is supported |
af_prt=moburst |
No |
|
af_channel |
Used for filtering by channel name, comma separated multiple selection is supported |
af_channel=Instagram |
No |
|
af_siteid |
Used for filtering by publisher id, comma separated multiple selection is supported |
af_siteid=12345678 |
No |
|
geo |
Used for filtering by country, comma separated multiple selection is supported |
geo=US,DE |
No |
|
currency |
All monetary values in the report are according to the App's Admin's choice of currency |
currency=preferred |
No |
|
timezone |
The report is generated according to the App's Admin's choice of time. |
timezone=preferred |
No |
Available Groupings
These are for collecting the data into groups to allow easier and more accurate examination of the information.
|
Dimension |
Display Name |
LTV KPIs |
Retention KPIs |
Activity KPIs |
|---|---|---|---|---|
|
app_id |
App ID |
Yes |
Yes |
Yes |
|
pid |
Media Source |
Yes |
Yes |
Yes |
|
af_prt |
Agency |
Yes |
Yes |
Yes |
|
c |
Campaign |
Yes |
Yes |
Yes |
|
af_adset |
Adset |
Yes |
Yes |
Yes |
|
af_ad |
Ad |
Yes |
Yes |
Yes |
|
af_channel |
Channel |
Yes |
Yes |
Yes |
|
af_siteid |
Publisher ID |
Yes |
Yes |
Yes |
|
af_keywords |
Keywords |
Yes |
Yes |
Yes |
|
is_primary |
Is Primary Attribution |
Yes |
No |
Yes |
|
af_c_id |
Campaign ID |
Yes |
No |
Yes |
|
af_adset_id |
Adset ID |
Yes |
No |
Yes |
|
af_ad_id |
Ad ID |
Yes |
No |
Yes |
|
install_day |
Install Day |
Yes |
Yes |
Yes |
|
attributed_touch_type |
Touch Type |
Yes |
Yes |
Yes |
|
geo |
GEO |
Yes |
Yes |
Yes |
List of KPIs
The Key Performance Indicators (KPI) are the metrics used for gaining an insight into the behavior of your app in different ways.
|
KPI |
KPI Family |
Description |
|
impressions |
LTV |
Number of impressions within the selected time frame |
|
clicks |
LTV |
Number of clicks within the selected time frame |
|
installs |
LTV |
Number of installs within the selected timeframe |
|
cr |
LTV |
Conversion Rate |
|
sessions |
LTV |
Number of sessions created by the users who installed within the selected time frame |
|
loyal_users |
LTV |
Number of loyal users who installed within the selected time frame |
|
loyal_users_rate |
LTV |
Loyal users / installs |
|
cost |
LTV |
Total cost in the selected timeframe |
|
revenue |
LTV |
Lifetime revenue generated by the users who installed in the selected time frame |
|
roi |
LTV |
Return on Investment over a certain time frame |
|
arpu_ltv |
LTV |
Average revenue per user, for the users who installed in the selected time frame |
|
average_ecpi |
LTV |
Effective Cost per Installation (eCPI) over a certain time frame |
|
uninstalls |
LTV |
Uninstalling users, who installed in the selected time frame |
|
uninstalls_rate |
LTV |
Uninstallation rate |
|
event_counter_[event%20name] |
LTV |
Number of events generated by users who installed within the selected time frame |
|
unique_users_[event%20name] |
LTV |
Number of unique users who performed the event |
|
sales_in_usd_[event%20name] |
LTV |
Revenue reported as part of the reported events |
|
retention_day_[x] |
Retention |
Number of retained users at day X |
|
retention_rate_day_[x] |
Retention |
Number of retained users at day X out of installing users |
|
activity_average_dau |
Activity |
Average daily active users (DAU) within the selected timeframe |
|
activity_sessions |
Activity |
Number of sessions performed within the selected timeframe |
|
activity_revenue |
Activity |
Revenue reported within the selected timeframe |
|
activity_event_counter_[event%20name] |
Activity |
Number of events generated by users within the selected time frame |
|
activity_sales_in_usd_[event%20name] |
Activity |
Revenue reported as part of the reported events within the selected time frame |
Sample Requests
IMPORTANT NOTES:
- Unless timezone=preferred and currency=preferred are used in the query URL, the report is generated in UTC (GMT) and USD. Use these parameters ONLY if you have previously changed the default values for the app's dashboard, UTC for timezone and USD for currency.
- If the Admin changed the preferred time zone in the dashboard within the requested time range, the generated report contains values from the last change only.
- Costs, clicks and impressions related to Facebook and Google are currently not supported.
- Specific groupings are only available for LTV KPIs, Activity or Retention KPIs. The API returns N/A when the data for a specific KPI is not available. For example, requesting retention_rate_day_7 grouped by af_channel will return “N/A”.
- Data Freshness: The data is aggregated on a daily basis, and it may take up to 12 hours for the previous day’s data to be available
- If all apps have the same configuration (whether by default or not), the common configuration is used. Otherwise, (different configurations per app), GMT and USD are not used.
- Maximum lines count: 200K