Partners

get

https://hq1.appsflyer.com/api/agg-data/export/app/{app-id}/partners_report/v5

⚠️
Important
This API returns a redirect to the report URL. If you copy the example cURL command into a terminal, add the -L flag manually to follow the redirect. Without -L, curl returns no data.

Data is grouped by media source and campaign.
Data type: LTV
For details, see KB link

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

app-id

string

required

Application ID

Query Params

from

date

required

From date (report start date)

date

required

To date (report end date)

media_source

string

Use to filter by a specific media source
Set both the category and media_source parameters as follows:

For Facebook set category and media_source to facebook
For Twitter set category and media_source to twitter
For all other media sources set category to standard and media_source to the name of the media source.
Examples
media_source=facebook&category=facebook
media_source=abc_example&category=standard

category

string

enum

facebook: Get only facebook data with the following groupings: campaign_id, adset, adset_id, adgroup, adgroup_id
organic: Get only organic data without the following groupings: campaign_id, adset, adset_id, adgroup, adgroup_id
standard (default):
- media_source: Get data only for the specified media_source without the following groupings: campaign_id, adset, adset_id, adgroup, adgroup_id
- media_source=facebook: Get only facebook data with the following groupings: campaign_id, adset, adset_id, adgroup, adgroup_id
- without media_source or media_source=all: Get all media_source without the following groupings: campaign_id, adset, adset_id, adgroup, adgroup_id

Allowed:

attribution_touch_type

string

enum

Set this parameter as shown in the example to get view-through attribution (VTA) KPIs.

Allowed:

currency

string

enum

Currency of revenue and cost.
Aggregate Pull API reports always use the app-specific currency.

Allowed:

reattr

string

enum

Get retargeting conversions data.
[Default] is false - user acquisition data (UA) campaigns returns.
If true, retargeting conversion returns.

Allowed:

timezone

enum

[Default] If the parameter is not sent, data returns using UTC.
Data returns using the app-specific time zone.
Time zone format takes into account daylight saving time.
The timezone 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/Paris.
Pulling data in the selected time zone is only available from the date when the timezone setting was made. Any data prior to the date of the change uses UTC as the timezone.

Choose a time zone

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/csv

application/json

200Reports returned in CSV format

400Bad Request

401Account may be suspended. Log in to the dashboard and check the account status.

404App ID wasn't found. Ensure that the app ID is correct. iOS apps must start with ID. The token doesn't match the app. Are you using the correct token?