The Branch Custom Exports find and queue log records that match your search criteria for export. You can do so either via the Custom Exports section in your Branch dashboard OR via API.

Custom exports endpoints are limited to a maximum of 2 million records each and can query up to 120 days prior to the date of export.

If more records are required, please make multiple requests with smaller time intervals to pull the necessary data in "batches". In some cases, Branch can increase the number of records above 2 million. Please contact Support to request an increase.

Calls to the Custom Export API require an api_key or access token parameter to be passed with each request. API Keys are generated on a per-user basis and are permanent.

Learn how to retrieve your API key (a.k.a. Access Token)

Rate limits depend on the endpoint you are making a request to.

For creating exports, the rate limit is 10 requests per minute and 25 requests per hour.

For checking the status of an export, the rate limit is 50 requests per minute and 1000 per hour.

In order to access Custom Exports, a user will need to have both Sensitive Data and Export access.

For more details on how to give a user the required access, please follow Granting a User Export Access.

Any user with access to an account’s API keys will be able to access Branch’s Custom Export API (and thus unfiltered, log-level data). As a result, we would recommend against providing third parties with the permissions required to view API keys during the invitation process.

Providing Agencies API Access

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

To provide an agency team member with access to the Custom Export API:

1. In the left-hand navigation, under Setup & Testing, 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:
   1. Under Access Level, check the Export box.
   2. Under Permissions, check the Sensitive Data box.
5. Optional: add data filters
   1. Under Data Filters, toggle any necessary data filters on/blue. Exported data will be filtered accordingly.
6. Click Save.

Please refer to the full list of available topics for Branch and TUNE.

Please refer to the full list of available fields for Branch and TUNE.

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.

To request an export:

1. In the left-hand navigation, under the Setup & Testing section, click Data Import & Export, then click on Exports.
2. On the Custom Exports page, provide the following:
   • The appropriate Date Range.
   • The Topic type the export should include.
   • The Columns of fields you want included.
   • Any additional Filters you want included.
   • The Download Type for the export.

You can also view any requested export in the Custom Exports Created table which includes:

• Date Created
• Topic / Date Range
• Row Count
• Format
• Status

Endpoint Definitions

Building the Export Request

Find and queue all records that match search criteria for export; returns a “handle” to be used in the download export request.

Sample Export Request

Sample Export Response

Building the Download Export Request

Finds and exports requested queue (by handle) and provides URL location for download.

Sample Download Export Request

• BRANCH REQUEST

Sample Download Export Response

Branch Available Topics

TUNE Available Topics

• Clicks
• Event Items
• Events
• Impressions
• Installs
• Opens

Branch Available Fields

TUNE Available Fields

Field Value Changes

When exporting the following fields, you will notice a difference between the value TUNE provides vs the value Branch provides.

• Country Name
  • TUNE: Korea - South
  • Branch: Republic of Korea
• Region Name
  • TUNE: seoul teugbyeoisi
  • Branch: Seoul
• City Code
  • TUNE: 2261 (Seoul)
  • Branch: 1835848 (Seoul)
• Language
  • TUNE: ko, ko-KR, en-KR
  • Branch: KO

Including Fields from Related Data Objects

Related objects no longer use periods ( . ) to access the properties on the object. Rather, field names use underscores ( _ ) only.

For example, site_event.id will now be exported as site_event_id.

Cthulhu Filter Specification

Please refer to the Cthulhu Filter Specification if you are unsure how to properly format the filter.