Using Master API—campaign performance KPIs

https://hq.appsflyer.com/export/master_report/v4?api_token=api_token &app_id=app_id&from=from&to=to&groupings=groupings&kpis=kpis

Call parameters

Parameter	Value	Mandatory
api_token	The admin needs to retrieve the token. To retrieve the API token, click your email > API Tokens.	Yes
app_id	App identifier, as found in AppsFlyer. Insert the app ID exactly as found in AppsFlyer Prefix iOS apps with id	Yes
from	Lower bound of the LTV attribution date range. Format: String yyyy-mm-dd Example: "from": "2020-01-02"	Yes
to	Higher bound of the LTV attribution date range Number of the days in the range: 1-31 days For a single day: from and to values are identical.  Format: yyyy-mm-dd Example: "from": "2020-01-01", "to": 2020-01-31 is 31 days.	Yes
groupings	Group by parameters, separated by a comma. See the Groupings table for the list available  Example: groupings=pid,geo	Yes
kpis	List of KPIs to include, each separated by a comma. See the KPI table that follows for a list of KPIs. Example:kpis=installs,clicks, impressions,sessions,retention_day_7	Yes
filters	Data can be filtered using one or more filter options.	No
currency	To return data using the app-specific currency set currency=preferred	No
timezeone	To return data using the app-specific timezone set timezone=preferred	No
format	By default, the response data is received in CSV file format. If you prefer to get the data in JSON format append &format=json to the URI	No

These dimensions are used for collecting the data into groups to allow easier and more accurate examination of the information. You can find descriptions of these fields here.

KPIs are the metrics used for gaining an insight into the behavior of your app. The KPI's are grouped by type in the tabs that follow. 

Calculated KPIs

In addition, to the KPIs described previously, you can add calculated KPIs to your master API reports. This enables you to have your own calculated reports included in your Master API reports.

You can insert any number of built-in KPIs in the calculated KPI formulas.

Standard arithmetic operators are supported: addition (+) encoded as %2b, subtraction (-), multiplication (*), division (/) encoded as %2f.

Calculated KPI field names must start with "calculated_kpi_", followed by any valid string, such as, "calculated_kpi_purchaserate".

kpis=installs,loyal_users_rate&calculated_kpi_3days_retention=
retention_day_1%2Bretention_day_2%2Bretention_day_3

kpis=installs&calculated_kpi_rev_per_impression=revenue%2Fimpression

kpis=installs,roi,arpu_ltv,cost,revenue&calculated_kpi_roi_day_7=
(cohort_day_7_total_revenue_per_user-average_ecpi)%2Faverage_ecpi

The following time granularity options are available: Daily, Weekly

• You use the time frame fields, To and From, to determine the desired granularity in the selected time range. KPIs are displayed in accordance with your selection of either daily or weekly granularity.
• When you select either weekly or daily granularity, ensure that the KPIs chosen correspond to the granularity level. To learn more, click here.
• Exact week numbers can be found here.

Local currency and app-specific time zone are set on the app settings page. Master API data can extract the data using either the system default currency and time zone or using the app-specific time zone and currency. 

The following applies:

• Using the app-specific time zone/currency is supported only If all apps have the same timezone/currency. Otherwise, UTC and USD are used. Time zone and currency are separate. Meaning that if the currency of all apps is the same but the time zones not, then you can use the app-specific currency but not the app-specific time zone. 
• Localization is not supported in Weekly Retention KPIs
• If the preferred time zone was changed in the dashboard within the requested time range, the generated report contains values starting from the most recent time zone change.

Use the following parameters to select the app-specific setting. Note: If you don't use the preferred parameters, you get the default settings, which are USD for currency and UTC for time zone. 

For results to appear in the Master API according to Time Zone, the timezone=preferred parameter must be used.

Compare Facebook ads performance:

https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]
&app_id=com.greatapp&from=[from_date]&to=[to_date]&pid=facebook
&groupings=pid,c,af_adset_id,af_ad_id
&kpis=installs,clicks,impressions,sessions,loyal_users,cost,revenue,arpu_ltv,roi

https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]
&app_id=com.greatapp,id123456789&from=[from_date]&to=[to_date]&pid=googleadwords_int
&groupings=pid,c,af_adset_id,af_ad_id
&kpis=installs,sessions,loyal_users,cost,revenue,arpu_ltv,roi

https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]
&app_id=all&from=[from_date]&to=[to_date]&groupings=geo,pid,c&kpis=
installs,clicks,impressions,sessions,loyal_users,cost,revenue,arpu_ltv,
roi&geo=us,ca	

https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]
&app_id=com.greatapp&from=[from_date]&to=[to_date]&groupings=af_keywords
&kpis=roi,arpu_ltv,average_ecpi,installs,loyal_users_rate,cost,revenue

https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]
&app_id=com.greatapp,id123456789&from=[from_date]&to=[to_date]&groupings=af_prt,pid,c&kpis=installs,
loyal_users_rate

https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]
&app_id=com.greatapp&from=[from_date]&to=[to_date]&groupings=af_siteid&pid=affiliates
&kpis=installs,loyal_users_rate,arpu_ltv,retention_day_1,retention_rate_day_1,
retention_day_7,retention_rate_day_7,retention_day_15,retention_rate_day_15,
retention_day_30,retention_rate_day_30

https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]
&app_id=com.greatapp,id123456789&from=[from_date]&to=[to_date]&groupings=attributed_touch_type
&kpis=installs,sessions,loyal_users_rate,arpu_ltv

https://hq.appsflyer.com/export/master_report/v4?api_token=[api_token]
&app_id=all&from=[from_date]&to=[to_date]&groupings=pid,c
&kpis=installs,loyal_users_rate,retention_day_1,retention_rate_day_1,
retention_day_7,retention_rate_day_7,retention_day_15,retention_rate_day_15,
retention_day_22,retention_rate_day_22,retention_day_30,retention_rate_day_30

• Cost data: 
  • Cost data, including eCPI, may not always be available. This depends on whether the network supports cost data, the type of the network, i.e., using AppsFlyer links or self-reporting, and the requested dimensions. To get eCPI, provided the cost is available, include both installs and cost in the call. 
  • In general, all sources, including owned media, which use AppsFlyer links and have the cost parameter on the links, fully support cost data, regardless of the requested dimensions. Self-reporting networks, with their own API, usually support cost data with only some of the available dimensions.
  • For example, Facebook doesn’t support grouping by Geo and Channel at the same time (grouping by either of them separately is supported).
  • For the full list of ad networks supporting cost data click here.
• Groupings: 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”.

• Maximum lines count: 200K