Dashboard Custom Exports

Export select device-level Branch event data through the Dashboard.


Branch data is valuable when it comes to truly understanding your campaign performance. One way to understand Branch data at a granular level is through Branch Custom Exports. Users with the correct permission can access Custom Exports via the Branch Dashboard (this guide) or via the Custom Exports API.

Custom Exports through the Branch Dashboard will be outputted in CSV or JSON.



Apple requires users to opt in to sharing their device data through Apple's AppTrackingTransparency framework. When an install is attributed to paid ads, a 2nd install event will fire post user opt-in

用户是否选择加入将影响您的最终安装数量。我们建议使用一个不同的标识符 (如IDFV) 来对内部系统上的安装事件进行去重。

For additional information on changes post iOS 14.5, visit our FAQ Pages.



Max number of days that can be queried at a time

60 days

Max number of records per export

2 million

Max lookback

120 Days


  • 每分钟10个请求
  • 25 requests per hour

Test Environment Custom Export


Identical Requests

Export requests made within 60 minutes will be cached to avoid the case of hundreds or thousands of requests being made for the exact same data set within seconds or minutes of each other. After 60 minutes, your request will kick off a new job to retrieve data.

If more records are required, please make multiple requests with smaller intervals to pull the necessary data in "batches".


In order to access Custom Exports, you need to have completed the following:

  1. Created a Branch Dashboard.
  2. Enabled Data Feeds for your Branch account.
  3. Implemented the Branch SDK into your mobile app (iOS | Android)
  4. Have Sensitive Data and Export access.

Agency Access

If you work with an agency that runs your advertising campaigns and you want to give them access to export the subsequent data, you can provide them with access to the Custom Exports

为代理商团队成员提供对 Custom Export API 的访问权限,请执行以下操作:

  1. In the left-hand navigation, under Configure, click on Account Settings.
  2. On the Account Settings page, click on the Agencies tab.
  3. Expand the agency in question, find the agency team member you want to give access to, hover on the button in the Actions column and click Edit.
  4. In the Edit Agency Team Member modal:
    • Under Access Level, check the Export box.
    • Under Permissions, check the Sensitive Data box.
  5. 可选:添加数据筛选项
    • Under Data Filters, toggle any necessary data filters on/blue. Exported data will be filtered accordingly.
  6. 点击保存

Pre-Configured Exports

Use pre-configured exports to quickly access specific exports configured by Branch or created by other users who have access to your Branch Dashboard.

After logging in to Branch Dashboard, in the left-hand navigation, under the Exports section, click Custom Exports. Pre-configured exports should be accessible through the dropdown, and selecting one will overwrite anything set in the Create Custom Exports section with pre-configured settings (topic, dimensions, filters).


Default Pre-Configured Exports

Branch supplies a set a pre-configured exports that will make getting started easier:

Pre-Configured Export


Paid Attributed Installs

Export attributed installs for paid ads campaigns.

SAN Attributed Installs

Export attributed installs for ads campaigns from self-attributing networks (Facebook, Google Adwords, Google Marketing Platform, Twitter, Snap, Apple).

SAN Attributed Purchase

Export attributed commerce events for ads campaigns from self-attributing networks (Facebook, Google Adwords, Google Marketing Platform, Twitter, Snap, Apple).

SAN Touch

Export self-attributing network touches used for measuring multi-touch attribution.

Non-Paid Channels Installs

Export attributed installs for non-paid ads channels.

Acquisition Cohort Purchase

Export attributed purchase events.

Create Custom Exports

After logging in to Branch Dashboard, in the left-hand navigation, under the Exports section, click Custom Exports.


1. Set Dates, Times, and Timezone

When setting your date, time, and timezone, be sure that your export is within the limitations.

2. Set Topic

The topic you select should be based on what you are looking to export. For most cases, you will want to select the topic that matches your event name. See below to outline which topic to select based on the event:

Topic Event Mappings:




  • 添加到购物车
  • 加到收藏夹
  • 查看购物车
  • 发起购买
  • 添加付款信息
  • 点击广告
  • 购买
  • 保留
  • 消费积分
  • 查看广告

Content Event

  • 搜索
  • 查看商品
  • 查看商品
  • 频率
  • 分享
  • 启动流
  • Complete Stream

用户 Lifecycle Event

  • 完成注册
  • 完成教程
  • 达标级别
  • 解锁成就
  • 邀请
  • 登录
  • 开始试用
  • Subscribe
  • 选择加入
  • 选择退出


All other event names

3. Select Columns

The columns you select are dependent on what you are looking to understand out of your export.

4. Configure Filters

You can add filters to get even more granular with what you are exporting. Filters help you specify the values for the columns you are looking to export.

Example Custom Exports

There are many purposes for initiating a Custom Export depending on the type of data you are looking to analyze. Below are a few examples:

Android & iOS Installs with Device IDs







  • Attributed
  • 操作系统
  • AAID
  • Android ID
  • IDFA
  • IDFV
  • Developer Identity(开发者身份)



Purchase Event Data







  • Attributed
  • 名称
  • Campaign
  • 内容项
  • Coupon
  • Customer Event Alias
  • 自定义数据
  • 货币
  • Developer Identity(开发者身份)
  • Event Timestamp
  • 操作系统
  • Revenue
  • Revenue in USD
  • Shipping
  • Tax
  • 交易 ID
  • timestamp


Name equals PURCHASE