Pull API aggregate data

For:

Marketers Developers

Last update: May 28, 2023 09:35

At a glance: Use this Pull API to get your AppsFlyer aggregate reports in CSV files.

Looking for Pull API raw data?

Learn all about it here.

Pull API aggregate data

Pull API lets you get aggregate data reports for user acquisition (UA) and retargeting in CSV files.
Data freshness rates are the same as the equivalent report on the Export Data page and Overview dashboard page. Consider that cost can update with a delay of several hours, depending on the partner providing the cost data.
Filter by options available: Media source and date range.
Additional capabilities in Pull API are:
- Add attribution touch type
- Select timezone

Aggregate performance reports available via Pull API

Category	UA	Retargeting*
Partners (media source)	✓	✓
Partners by date	✓	✓
Daily	✓	✓
Geo	✓	✓
Geo by date report	✓	✓
* For retargeting reports, add the `&reattr=true` to the URI.

Using Pull API aggregate data

To use Pull API aggregate data:

Get the API token. An admin needs to retrieve the token.
Give your developer the API token to be used in the authentication header.
Give your developers the parameters to input when they make the API call, as described in the section that follow. The parameters determine what the report focuses on, how it's organized, and provide a reporting timeframe.
Tell your developer to follow their Pull API aggregate data instructions in the developer hub.

Parameters

Parameter	Description
app_id	Application ID
from	The date range consists of a `from`and `to` parameter. The range is the LTV (install) date range. Format: `yyyy-mm-dd`, Example: 2010-01-01
to	End date. As for `from`
media_source	Use to limit (filter) to a specific media source. Example:`media_source=facebook`
attribution_touch_type	Set this parameter as shown in the example to get view-through attribution (VTA) KPIs. Example: `attribution_touch_type=impression` Some VTA KPIs, like clicks, impressions, and cost APIs, don't have values associated with them and display the value N/A instead.
currency	Currency of revenue and cost. Aggregate Pull API reports always use the app-specific currency.
reattr	Get retargeting conversions data. [Default] If false, user acquisition data (UA) campaigns returns. If true, retargeting conversion returns. Example:`reattr=true`
timezone	[Default] Data returns using UTC. Template URIs are populated with the timezone parameter set to the app-specific time zone. [Default] If the parameter is not sent, data returns using UTC. If you send`timezone=[Joda-Time]`, data returns using the app-specific time zone. Notes about selecting timezones Joda-Time time zone format takes into account daylight saving time. The Joda-Time value must be identical to the value in the app settings page. For example, if the timezone setting is Paris, the timezone value in the Pull API URL should be `timezone=Europe%2fParis`. Pulling data in the selected time zone is only available from the date when the time zone setting was made. Any data prior to the date of the change uses UTC as the timezone.

Traits and limitations

Trait	Comments
API token type required	V2.0 token
Ad network access	N
Agency access	Y
Agency transparency	Y
App-specific currency	Y
App-specific timezone	Y
Cost	Cost data is for UA campaigns only; not for retargeting or inactive campaigns (campaigns without any installs).
Data freshness	Continuous
Historical data	5 years
Non-organic data	Y
Organic data	Y
Rate limitations	Limitation
Size limitations	API calls return a max. of 200K rows. If a report has exactly 200K rows, then assume rows are missing. Make multiple API calls, using from/to parameters that include the time of day. Note! Pull API for raw data support 1M rows. Aggregate data reports are limited to 200K rows.
Campaign name changes	Pull API reports don't support campaign name changes