Overview

Branch’s Daily Exports pull granular Branch event data directly. You can do so either via the Daily Exports section in your Branch dashboard OR via API directly.

A few important notes:

• The data will only be retrievable for up to 6 months in the past
• The data will only be retrievable for up to 7 days at a time
• The data will only appear after end of day since it's processed every 24 hours
• The data will not be visible prior to your whitelisting date. After you sign up, data will be generated for the next UTC day or the following UTC day.
• The data will only be visible for your live key (not your test key).
• Click data related to SANs (e.g. Google Ads) can be found at the campaign level rather than device level.

❗️

Data Hashing After 7 Days

In accordance with our internal policies related to GDPR and other data protection laws, we hash many fields, including IP address and advertising identifiers, after 7 days.

This means that if you want to export data beyond 7 days, either via the Dashboard's CSV Exports or by requesting a manual data dump, these fields will no longer contain the original values.

For this reason, we highly recommend you always export raw data within 7 days.

📘

Data Feeds is a premium solution

The Daily Export API is included in Branch’s Data Feeds offering, which can be purchased according to Branch’s pricing schedule, and is available at no additional charge to customers who are on Launch and Startup plans for Journeys, Universal Email, or Universal Ads.

Without Data Feeds, you can still export Branch data in CSV form directly from the Branch dashboard via Sources or CSV Exports.

❗️

Third party access

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

Requirements

• You must have a Data Feeds subscription.
• Toggle on the Data Export API using the slider on the Data Feeds Manager page.
• To access the API, you must have Sensitive Data and Export access.

Access via Branch Dashboard

Rather than accessing the Daily Export API directly, you can use the Daily Exports section in your Branch dashboard to request the appropriate data via CSVs.

📘

CSV Delivery

Any data you export via the dashboard will be included in a CSV attachment in an email. Please ensure your email address is up to date in Account Settings.

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 Daily Exports page, select the period of time you wish to export data for.
   • Last 1 days
   • Last 3 days
   • Last 7 days
   • Custom
3. Select the type of events you want to export:

• Individually by clicking the respective Download arrow
• En masse by clicking the Export All button.

Upon request, you will receive a confirmation email verifying the details of your request. Once we finish processing your export, you will receive another email that includes as CSV attachment. Please keep in mind larger exports require more processing time.

Access via API

In order to use this API you must have an App ID and a Branch Public Key.

You can find your keys in your Account Settings.

Base URL:
https://api2.branch.io/v3/export/

Endpoint

• POST https://api2.branch.io/v3/export
• Content-Type: application/json

Query Parameters

branch_key required:
The Branch key of the originating app

branch_secret required:
The Branch secret key of the originating app

export_date required:
The UTC date of the requested data export

Example request:

curl -X POST api2.branch.io/v3/export -H 'content-type:application/json' -d '{"branch_key":"key_live_gcASshuadd7l39m36NhdsDPWRjmkdcgh12jsg1", "branch_secret": "secret_live_ztPsdKIjUtcjkUYF732nsl81HJ75BJqiv24J86", "export_date": "2017-10-21"}'

📘

Windows Command Prompt Formatting

Please note that if you are trying to run this curl command in Command Prompt on a machine running Windows, you will need to change ' to " and escape the " in curly brackets with a \. Here is a final example: curl -X POST api2.branch.io/v3/export -H "content-type:application/json" -d "{\"branch_key\":\"key_live_gcASshuadd7l39m36NhdsDPWRjmkdcgh12jsg1\", \"branch_secret\": \"secret_live_ztPsdKIjUtcjkUYF732nsl81HJ75BJqiv24J86\", \"export_date\": \"2017-10-01\"}"

Response

The response payload will be in JSON format and for each export it will have an array of paths to files on S3 to download. Note that there may be multiple files (depending on the size of the day's export) and that each csv file will be gzipped. Each of the keys in the below example may not be present in the response depending on if you had any events for that topic for the specified day.

{
 "eo_branch_cta_view": <Array of String(s)>,
  "eo_click": <Array of String(s)>,
  "eo_commerce_event": <Array of String(s)>,
  "eo_content_event": <Array of String(s)>,
  "eo_custom_event": <Array of String(s)>,
  "eo_impression": <Array of String(s)>,
  "eo_install": <Array of String(s)>,
  "eo_open": <Array of String(s)>,
  "eo_pageview": <Array of String(s)>,
  "eo_reinstall": <Array of String(s)>,
  "eo_sms_sent": <Array of String(s)>,
  "eo_user_lifecycle_event": <Array of String(s)>,
  "eo_web_session_start": <Array of String(s)>,
  "eo_web_to_app_auto_redirect": <Array of String(s)>,
  "eo_dismissal": <Array of String(s)>
}

All exports via Data Feeds are powered by Branch's People-Based Attribution. For an exhaustive list of events included in these exports and more detailed definitions of each event, please see the Event Ontology Data Schema.

📘

Info

A full day's files will be available on our S3 bucket at that location to download around 7:00pm UTC. It will return a blank array from S3 for any empty files until the UTC day is over and the data has been transfered to S3, therefore it is recommended you schedule any ETLs to fetch the data for the previous day around 7:00pm UTC (12pm PST).

❗️

IP Discrepancies

Geographic data, such as country and city, may not be available for a very small percentage of events where the IP cannot be resolved to a location.

Support

Time Limits

Data will be available through the API only for 6 months after the date it's posted. If you need a record of your data for longer than 6 months, please set up a recurring export and store data in your systems.

Exporting beyond 7 days

In accordance with our internal policies related to GDPR and other data protection laws, we hash many fields, including IP address and advertising identifiers, after 7 days. This means that if you want to export data beyond 7 days, either via the Dashboard's CSV Exports or by requesting a manual data dump, these fields will no longer contain the original values. For this reason, we highly recommend you always export raw data within 7 days.

📘

Manual Data Dump

Due to the resources required to complete a manual data dump, this service is available to Branch Enterprise tier clients only.

File Limitations

When using Daily Exports, multiple files are expected with 200K rows per file. If your export has less than 200K rows, there will only be one file.