Use the Cross-Events Export API to funnel your SKAdNetwork and Non-SKAdNetwork data into your preferred data warehouse.
Overview
Unified Analytics has been a great tool for viewing campaign data from all attribution methods in a single view. Now you can get this valuable data in your data warehouses using the Cross-Events Export API. Unified Analytics Exports introduces a new data_source
called skan_unified_view
to use.
Common Use Cases
- Export your unified total conversions
- Compare SKAdNetwork and Non-SKAdNetwork total counts
- Compare SKAdNetwork and Non-SKAdNetwork revenue
Access Restrictions
Before you configure your cloud account, make sure your Branch account has access enabled for the Cross-Events Export API. Access to the Cross-Events Export API is restricted to Enterprise accounts. Please contact your Branch Account Manager to confirm if your account is eligible for enablement.
Example Usages
Export Unified Complete Registrations by Campaign ID
curl --request POST \
--url 'https://api2.branch.io/v1/branch_aggregate/async/analytics?app_id=123456789' \
--header 'Access-Token: api_app_123456789abcdefghi' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"filter": {
"type": "selector",
"dimension": "name",
"value": "COMPLETE_REGISTRATION"
},
"granularity": "all",
"response_format_compression": "gz",
"response_format": "json",
"start_date": "2024-04-28",
"end_date": "2024-05-05",
"dimensions": [
"name",
"last_attributed_touch_data_tilde_campaign_id"
],
"aggregations": [
{
"field_name": "unified_total_count",
"data_source": "skan_unified_view",
"display_name": "total_count"
}
]
}
'
{"name":"COMPLETE_REGISTRATION","last_attributed_touch_data_tilde_campaign_id":"1624766361","total_count":1.0}
{"name":"COMPLETE_REGISTRATION","last_attributed_touch_data_tilde_campaign_id":"452798654","total_count":2197.0}
{"name":"COMPLETE_REGISTRATION","last_attributed_touch_data_tilde_campaign_id":"7ceb4624-b7a8-43c1-8c95-247fd3ffa582","total_count":274.0}
{"name":"COMPLETE_REGISTRATION","last_attributed_touch_data_tilde_campaign_id":"120206639272860749","total_count":2091.0}
{"name":"COMPLETE_REGISTRATION","last_attributed_touch_data_tilde_campaign_id":"1797766853010482","total_count":10.0}
{"name":"COMPLETE_REGISTRATION","last_attributed_touch_data_tilde_campaign_id":"2dd25d10-d388-4ecf-894e-2b68b2185708","total_count":15.0}
{"name":"COMPLETE_REGISTRATION","last_attributed_touch_data_tilde_campaign_id":"671357963","total_count":607.0}
{"name":"COMPLETE_REGISTRATION","last_attributed_touch_data_tilde_campaign_id":"40790","total_count":1.0}
Compare Facebook Only SKAdNetwork and Non-SKAdNetwork Installs
curl --request POST \
--url 'https://api2.branch.io/v1/branch_aggregate/async/analytics?app_id=123456789' \
--header 'Access-Token: api_app_123456789abcdefghi' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"filter": {
"type": "and",
"fields": [
{"type":"selector","dimension":"last_attributed_touch_data_tilde_advertising_partner_name","value":"Facebook"},
{"type":"selector","dimension":"name","value":"INSTALL"}
]
},
"granularity": "all",
"response_format_compression": "gz",
"response_format": "json",
"start_date": "2024-04-28",
"end_date": "2024-05-05",
"dimensions": [
"name",
"last_attributed_touch_data_tilde_advertising_partner_name"
],
"aggregations": [
{
"field_name": "skan_count",
"data_source": "skan_unified_view",
"display_name": "SKAN_Count"
},
{
"field_name": "non_skan_unique_count",
"data_source": "skan_unified_view",
"display_name": "Non_SKAN_Count"
}
]
}
'
{
"name": "INSTALL",
"last_attributed_touch_data_tilde_advertising_partner_name": "Facebook",
"Non_SKAN_Count": 706086,
"SKAN_Count": 29
}
Appendix
Dimensions
app_id
attributed
name
timestamp
last_attributed_touch_data_dollar_3p
last_attributed_touch_data_tilde_advertising_partner_name
last_attributed_touch_data_tilde_campaign
last_attributed_touch_data_tilde_campaign_id
last_attributed_touch_data_tilde_feature
user_data_platform
event_timezone_adjusted_day
event_days_from_timestamp
Data Source + Field Name
data_source | field_name |
---|---|
skan_unified_view | - skan_count - skan_revenue - non_skan_revenue - unified_revenue - non_skan_total_count - unified_total_count - non_skan_unique_count - unified_unique_count |