At a glance: API access partners can use their API token to access advertisers' data, when granted permission by the advertiser, allowing them to extract performance metrics from the platform.
API access permissions
Advertisers can grant the following app-level permissions:
Permission type | Reporting tool | Limitations |
---|---|---|
Aggregated analytics reporting | Cohort analytics data via DataLocker | X Ads campaign data isn't available to API access partners due to their restrictions. |
SKAN reporting |
-- |
Considerations
-
Advertiser perspective
- Advertisers can grant the API access partner permission as listed in the preceding table.
- Partner perspective
- Extract data by API. Note: Security is implemented via an authentication token available in the AppsFlyer dashboard. The same token is valid for all apps and advertisers.
- Get data via Data Locker
- Advertisers can revoke permission to access their app data. This won't impact your partner credentials.
Granting access to the partner
Caution
- The permission type lets the partner access data, including traffic brought by other partners and organic data.
- Don't share your token with partners.
To grant API access to the partner:
- In AppsFlyer, from the side menu, select Collaborate > Integrated partners.
- Search for the partner and select it.
- Click Set up integration. You’re directed to the integration setup page.
- From the API access tab, turn on one or more permissions. Select from:
- Aggregate analytics reporting
- SKAdNetwork reporting (for iOS apps, not relevant for Data Locker)
- Click Save API access.
- Notify the partner that you have enabled the necessary API access.