At a glance: SKAN performance enriched with additional data points. Similar to the data in the SKAdNetwork dashboard. Aggregate using either the install date or postback arrival date.
SKAN aggregated performance report API
API basics
| Overview | The API returns attribution metrics reported by Apple SKAdNetwork (real data) and other data points using the install or postback arrival date. The report is similar in structure to the data presented in the SKAN dashboard. |
| Data freshness |
Data availability is according to the SKAN data freshness rate. |
| Path V1 |
V1 is deprecated. The sunset date will be announced in the future. |
| Path V2 |
|
| Path parameters (mandatory) |
|
|
Query parameters |
Listed in the table that follows. |
| HTTP method | GET |
| Response content type | text/plain |
| Authorization |
|
| Date limitations |
|
| Rate limitation |
|
| SRN-related remarks |
|
The admin | Parameter name | Format | Mandatory |
|---|---|---|
|
|
The date type used in the date range bounded by Options:
Google Ads data: The install and arrival dates are the same due to the Google Ads reporting methodology. |
No |
|
|
The install date range is bounded by start_date and end_date. Note! Install date differs from postback arrival date.
|
Yes |
end_date |
|
Yes |
view_type |
Filter the installs by type as follows:
|
No |
Request example (cURL)
curl --request \
GET 'https://hq1.appsflyer.com/api/skadnetworks/v2/data/app/<app_id>?start_date=2020-11-10&end_date=2020-11-20' \
--header 'Authorization: Bearer <V2_AUTH_TOKEN_HERE (700+ characters string)>'Report structure and example
The API returns a CSV file with the following naming scheme:
<app_id>_skadnetworks_report_<view_type>
_<start-date>_<end-date>_<unique-report_hash>_UTC_.csvAvailable fields
- Columns and metrics available are listed in the table that follows.
- Some metrics (revenue, engagement, conversion) depend on the SKAN performance measurement settings.
- The report includes only the in-app events that users performed during the reporting period. As such, the number and sequence of in-app event columns can change from report to report. Don't rely on column sequence in designing your data import process.
- Examples: V1 | V2
| Column name | Dimension or metric | Available in API V1 | Available in API V2 |
|---|---|---|---|
|
Date The data is according to the selected date_type. |
Group by | N | Y |
| Media Source (pid) | Group by | Y | Y |
| Campaign (c) |
Group by |
Y |
Y |
| Campaign ID | Group by | Y | Y |
| Site ID | Group by | Y | Y |
| Adset | Group by | N | Y |
| Adset ID | Group by | N | Y |
| Ad | Group by | N | Y |
| Ad ID | Group by | N | Y |
| Country | Group by | Y | Y |
|
AF Attribution Flag (Reserved for ZendeskConnect use) |
Group by | N | Y |
| Impressions | Metric | Y | Y |
| Clicks | Metric | Y | Y |
| CTR | Metric | Y | Y |
| Installs | Metric | Y | Y |
|
Click Through Installs (fidelity_type = 1) |
Metric | Y | Y |
|
View Through Installs (fidelity_type = 0) |
Metric | Y | Y |
|
Null Conversion Value Rate [Updated, Dec 13, 2021] Currently not populated |
Metric | N | Y |
| Conversion Rate | Metric | Y | Y |
| Converted Users | Metric | Y | Y |
| Converted Users/Installs | Metric | Y | Y |
| Total Revenue | Revenue metric | Y | Y |
| Total Cost | Metric | Y | Y |
| ROI | Revenue metric | Y | Y |
| ARPU | Revenue metric | Y | Y |
| Average eCPI | Metric | Y | Y |
| {af_skad_revenue} (Unique users) | Revenue metric | Y | Y |
| {af_skad_revenue} (Event counter) | Revenue metric | Y | Y |
|
{your in-app event name} (Unique users) |
Metric | Y | Y |
| {your in-app event name} (Event counter) | Metric | Y | Y |
Traits and limitations
| Trait | Remarks |
|---|---|
| Ad network access | If you are an analytics partner, ask the advertiser to grant you permission. |
| Agency access | Not available |
| App-specific time zone | UTC only |
| App-specific currency | Always USD |
| Organic data | Calculated as the difference between all data reported by SDK directly to ZendeskConnect less non-organic data reported by SKAN postbacks |
| Non-organic data | Calculated using SKAN postbacks received by ZendeskConnect |
| Historical data | Earliest conversion data (install or retarget) supported: November 1, 2020 |
| Team member access | The authorization token is available to the account admin in the dashboard. |
HTTP response codes and troubleshooting
| HTTP | Response |
Remarks |
|---|---|---|
| 200 | OK |
Valid data returned (CSV) |
| 200 | OK |
Empty report - no data found for the specified date range (CSV, only column names are returned).
|
| 400 | Bad request |
Missing or invalid query parameters |
| 401 | Unauthorized |
Authorization token is missing or invalid Make sure you use the token correctly |
| 403 | No permission | You don't have permission to access this report. If you are an analytics partner ask the advertiser to give you permission. |
| 404 | Not found |
|
| 429 | Too many requests |
Exceeded rate limitation |
Comments
0 comments
Article is closed for comments.