Pull APIs - Pulling AppsFlyer Reports by APIs

All AppsFlyer's CSV reports are available by APIs. Refer to your AppsFlyer account by going to the API Access Page for your secret key and examples. 

Pull_API_screen.png

API Parameters - Required

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

"api_token", "from" and "to" parameters are required.

For Raw Reports, the following parameters are also available:

  • 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
  • to report end date. Same format as from

API Parameters - Optional

Filtering reports by media source and re-attribution.

Filtering the reports to list only a specific media source is available by adding 2 parameters to the request:

For Re-Targeting Exports

reattr=true - used to retrieve re-targeting attribution reports.

Custom Reports with Pull API

fields The Pull API (v5 and up) supports customizing reports with selectable fields. This enables customers 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

Example:

Pull the list of all cities and their respective country codes that brought installs -https://hq.appsflyer.com/export/id341333333/installs_report/v5?api_token=24b7b9fe-6ddd-4ddd-94c8-xxxxxxxxxxx&from=2017-03-09&to=2017-03-10&fields=country_code,city

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

Time Zone and Currency

API Policy

Click here to see our API Policy

NOTE:  By default, the Pull API Performance Report shows Facebook data at Campaign level only.  Add "&category=facebook" to enable the report to present Facebook information at both the Ad Set and Ad level. This is relevant for Facebook only.

Pull API Link Examples

Report Category Report Type Link Example
Performance Reports Partners Report https://hq.appsflyer.com/export/id123456789/partners_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd
  Partners Daily Report https://hq.appsflyer.com/export/id123456789/partners_by_date_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd
  Daily Report https://hq.appsflyer.com/export/id123456789/daily_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd
  Geo Report https://hq.appsflyer.com/export/id123456789/geo_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd
  Geo Daily Report https://hq.appsflyer.com/export/id123456789/geo_by_date_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd
Raw Data Reports Installs Report https://hq.appsflyer.com/export/id123456789/installs_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd
  In-App Events Report https://hq.appsflyer.com/export/id123456789/in_app_events_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd
  Uninstalls Report
https://hq.appsflyer.com/export/id123456789/uninstall_events_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd
 
  Organic Installations Report https://hq.appsflyer.com/export/id123456789/organic_installs_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd
  Organic In-App Events Report https://hq.appsflyer.com/export/id123456789/organic_in_app_events_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd
Validation Rules Report Invalid Installs Report https://hq.appsflyer.com/export/id123456789/invalid_installs_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd&additional_fields=rejected_reason,rejected_reason_value
  Invalid In-App Events Report https://hq.appsflyer.com/export/id123456789/invalid_in_app_events_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd&additional_fields=rejected_reason,rejected_reason_value

 

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

NOTE: To use V4 Performance Reports, change v5 to v4.

For example, the v5 (in red) should be changed to v4.

https://hq.appsflyer.com/export/i{app_id}/geo_report/v5?api_token={api_token}&from={from_date}&to={to_date}

Was this article helpful?
1 out of 2 found this helpful
Have more questions? Submit a request
Powered by Zendesk