Pull APIs - Pulling AppsFlyer Reports by APIs

Introduction

AppsFlyer's CSV data reports are available for manual download through the Export Data page, and also via the Pull API.

Pull API enables app owners to receive CSV files of data about their apps by using specific URLs containing query parameters. Pulled reports can either be in aggregated or raw data forms. 

The Pull API links are all available in the API Access Page in each app's dashboard. 

API Parameters - Required

api_token

Is the user's external API Authorization Key: "{Account owner API Key should be used}"

from

Report start date in the format of "yyyy-mm-dd" or "yyyy-mm-dd hh:mm". For example: 2010-01-01 or 2010-01-01%2000%3A15 - (The hours parameter is for raw reports only).

to

Report end date. Same format as from

API Filtering Parameters - Optional

Filter by media source

Filtering the reports to list only a specific media source is available by adding both the category and media source parameters to the request URL:

category

To get Facebook data set category=facebook on the URL. For any other specific media source set category=standard 

media_source

Supply the name of a single media source (media_source=[SOURCE_NAME]) as it appears on AppsFlyer's dashboard.

https://hq.appsflyer.com/export/com.greatapp/installs_report/v5?api_token=xxxx
&from=2018-04-09&to=2018-05-09&category=standard&media_source=googleadwords_int

https://hq.appsflyer.com/export/com.greatapp/installs_report/v5?api_token=xxxx
&from=2018-04-09&to=2018-05-09&category=facebook&media_source=facebook

Filter by Event name

Filter the raw in-app events report data to include only a specific event, by using the event_name parameter. To filter multiple events use a comma separated list of events.

For example: event_name=af_purchase,ftd

For Retargeting Exports

Use reattr=true to get results attributed to retargeting campaigns.

Custom Reports with Pull API

fields 

Pull API supports customizing raw data reports with selectable fields (v5 and up). This enables marketers to download only relevant information to suit their requirements. 

To specify the requested fields, append the following fields parameter to the API call. 

Each column you request should be added to the fields parameter by specifying the API Column Name as it appears here. Example: fields=country_code,city

&fields=API_Name_A,API_Name_B

The full list of fields and their API names can be found here. 

Additional Fields

Through Pull API you can add some fields, that complete the picture for raw data installs and in-app events in some cases.

To add new fields add "&additional_fields=" to the tracking link, followed by the comma-separated list of additional fields. See the Pull API examples below.

The result is a CSV report with added columns, that contain information when relevant.

Time Zone and Currency

timezone (optional)

Add timezone= in the Pull API link to receive the report in the selected timezone (rather than GMT, by default). For raw data reports AppsFlyer supports two time zone formats, numerical (eg. +10:00) or Joda-Time (eg. Europe/Madrid). Joda-Time time zone format takes into account daylight saving time.
For example: timezone=%2B10:00 (url-encoded for +10:00). For Performance Reports only, the Joda-Time format is supported. For example:
https://hq.appsflyer.com/export/com.greatapp/daily_report/v5?api_token=xxxxxxxx&from=2016-11-09&to=2016-11-09&category=standard&media_source=googleadwords_int&timezone=Europe/Madrid

currency (optional)

Is used to receive the Revenue and Cost data in your selected currency, rather than in USD, which is the default option. This is set by the account admin.
currency=preferred is used to receive Revenue and Cost data in your selected currency.

API Policy

AppsFlyer's API Policy ensures high quality of service to the users of pull API by limiting the total number of daily requests and preventing abuse of the service.

The maximum number of records per report is 200K. If you get a report that has 200K rows then you have some results that were left out.

Pull API Link Examples

API Version (V5)

• Changes:

  • Version (v5) group Facebook campaigns only by campaign and not by campaign & ad group.

  • Export data page for aggregated reports uses the API version (v5)

• Unchanged:

  • The existing API (v4) is still available for use

  • The version does not apply any change to the file format or headers