Using Pull API raw data

About URI templates

• URI templates available in the dashboard are populated with the app ID and report type.
• They have placeholders for the API token and from/to dates which you need to edit.
• The portion of the URI to the right of the question mark (?) contains parameters. Each parameter begins with an ampersand (&). Parameters are used to set filters, specify additional fields to be included, currency, and timezone. For example, in raw data reports to limit (filter by) a specific media source, use the media_source parameter: &media_source=facebook
• To get a better understanding of Pull API, complete the tutorial that follows.
• Postback URIs aren't available via the dashboard. Postback URIs in a spreadsheet.

Getting your first Pull API report tutorial

• Ask an admin user to provide you with the Pull API token available in the dashboard.

To download a report from the dashboard: 

1. Go to Integration > API access.
   The API access page opens.
2. Select a report type. For example, Raw data reports > Retargeting conversions. 
   The URI template displays. 
3. Copy the URI by clicking on it.
4. Open a new tab in your browser, paste the URI.
5. Edit the URI:
   1. Replace the token placeholder with the Pull API token provided by an admin user.
      Example. Replace the token placeholder so that &api_token=12345678-1234-1234-1234-123456789012. Note! There are no spaces or other punctuation. 
   2. Replace the from/to placeholders with dates.
      Example: &from=2020-01-20&to=2020-01-31 Note! There are no spaces. Don't delete the &. 
6. Click <Enter> to send the API call. 
   The report downloads.

See the Protect360 raw data guide

If the results exceed the maximum, split the report using hours and minutes. Apply the following:

• from/to: yyyy-mm-dd hh:mm 
• from: 
  • Date only = from the beginning (00:00) of the chosen date
  • Date and time = from and including 00:00
• Parameter to: 
  • Date only = up to the end (24:00) of the chosen day
  • Date and time = up to, but not including, the shown time

Example: An app owner has 1300K daily installs from all sources. To overcome the 1M row limit, the app owner splits the day into two 12-hour URI calls. See the following table for options. 

Report fields are not added to the default list of fields so that new fields don't impact your import and ingestion processes. Use the additional_fields parameter to get non-default fields.

• List a field only once.
• See the list of available fields.
• Some URI examples include additional fields. If necessary, add more fields. 
• Example: additional_fields=device_download_time,deeplink_url
• Results are always returned for the fields listed in the table below.

https://hq.appsflyer.com/export/<APP ID HERE>/installs_report/v5?
        api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd
        &additional_fields=device_download_time,deeplink_url

Raw data: On December 1, 2021, the V4 API  will be sunset and removed from the platform. You must stop using V4 and migrate to V5 before this date. 

Migrating from API V4 to V5

In migrating from V4 to V5 consider that V5 has a set of default fields that always return and optional addtional fields which you must be explicitly added to your Pull API call. Adjust your API calls to get the fields you require. AppsFlyer provides a template consisting of some additional fields in the user interface. You should edit the template to meet your needs. See get API template in the user interface.