Rather than accessing the Custom Export API directly, you can use the Custom Exports section in your Branch dashboard to request the appropriate data via CSVs.
👉 Find more details on Custom Exports & API in Branch Help.
💡Note. Branch limited the interface to export data for 60 days or less. In general, it is recommended to export data for a day at a time.
How to request a report
Step 1. In the left-hand navigation menu, under Configure, click Exports.
Step 2. Open the Custom Exports tab.
Step 3. On the Custom Exports page, fill in the required details to set up your export:
1. Pre-configured Export: leave this option empty, as selecting a predefined export will overwrite your custom selections and filters, preventing the report from being configured correctly.
💡Note: If a report is already pre-selected, click Reset state for this page to clear it.
2. Date Range: specify the exact period you want to include in the export.
3. Time Zone: ensure the time zone matches the organization's time zone on the SplitMetrics Acquire dashboard.
4. Topic: choose from Installs, Reinstalls, Commerce Events, Content Events, User Lifecycle events, or Custom Events.
💡Tip. If you’re unsure which Topic to choose, hover over the information icon. It will show how the events are classified in Branch.
5. Columns: select the necessary columns. Use the Branch Field Name column in the table below 👇 as a reference.
6. Filters: apply filters to narrow down your data:
Set Ad Partner = Apple Ads to focus on Apple Ads traffic.
To extract data for a specific event and avoid overloading the report with unnecessary information, add a Name filter (e.g., Name = skip_tapped) to capture only that event.
7. Download Type: select CSV as the export format.
❗Important. Please avoid making any manual changes after downloading the report, as this could cause formatting issues.
💡Next Step. Once the report is received, our tech team will handle uploading all relevant data to the platform.
Fields to be included in the report
SplitMetrics Acquire report | Required for uploading | Branch Field Name | Example |
source | Required | In the CSV report: last_attributed_touch_data_tilde_advertising_partner_name
On the Custom Exports page:
| Apple Search Ads |
app_name | Required | In the CSV report:
| Smart Riddles |
campaign_id | Required | In the CSV report: last_attributed_touch_data_tilde_campaign_id
Campaign ID
| 1591938270 |
adgroup_id | Required | In the CSV report: last_attributed_touch_data_tilde_ad_set_id
Ad Set ID
| 1592121225 |
keyword_id | Required | In the CSV report: last_attributed_touch_data_tilde_keyword_id
On the Custom Exports page: Keyword ID
| 1592134194 |
keyword_text | Required | In the CSV report: last_attributed_touch_data_tilde_keyword
On the Custom Exports page:
| smile |
ad_id | Required | In the CSV report: last_attributed_touch_data_tilde_ad_id | -1 |
name/ type | Required | In the CSV report:
On the Custom Exports page: Name
| install/shop_opened_vip |
revenue | Required if you track revenue in SplitMetrics Acquire | In the CSV report:
On the Custom Exports page: Revenue
| 4,99 |
currency | Required if you track revenue in SplitMetrics Acquire | In the CSV report:
On the Custom Exports page:
| USD |
event_time | Required | In the CSV report:
On the Custom Exports page: Event Timestamp (ISO)
| 2017-05-14 17:20:11 |
open_time | Required | In the CSV report:
On the Custom Exports page: Install Timestamp (ISO)
| 2017-05-14 17:17:03 |
tap_time | Required | In the CSV report:
On the Custom Exports page: Last Attributed Touch Timestamp (ISO)
| 2017-05-14 17:16:01 |
user_id | Required for Count Policy One | In the CSV report: user_data_developer_identity
On the Custom Exports page: Developer Identity
| 18546f6154f67e29d1cb983322ad1329 |
adaccount_id | Optional for uploading but required for investigating discrepancies | In the CSV report: last_attributed_touch_data_tilde_advertising_account_id
On the Custom Exports page: Advertising Account ID
| 543458 |
geo_code | Optional for uploading but required for investigating discrepancies | In the CSV report: user_data_geo_country_code
On the Custom Exports page: Country Code
| US |
event_value | Optional for uploading but required for investigating discrepancies | In the CSV report: last_attributed_touch_data_custom_fields
On the Custom Exports page: Last Attributed Touch Custom Fields
| {"~conversion_type":"Redownload","+...} |
sdk_version | Optional for uploading but required for investigating discrepancies | In the CSV report: user_data_sdk_version
On the Custom Exports page: SDK Version
| 3.4.5 |
app_version | Optional for uploading but required for investigating discrepancies | In the CSV report: user_data_app_version
On the Custom Exports page: App Version
| 2.0 |
country_or_region | Optional for uploading | In the CSV report: last_attributed_touch_data_tilde_country_or_region
| GB |
platform | Optional for uploading but required for investigating discrepancies | In the CSV report: user_data_platform
On the Custom Exports page: Platform
| Ios/ Android |
🌟In addition to report-based exports, data can also be exported via the Branch API. Export via API is available based on the subscription package and is not supported on the Starter Plan. For more information, reach out to your Account Manager.