Data Integration Implementation Guide

Overview

Data Integrations provide an easy way to automatically send Branch data to your other analytics services and marketing tools using pre-formatted webhooks.

This guide will walk you through how to send your Branch data to our Data Integration partners. For most integrations, configuration just requires you to input your credentials and hit “Enable”.

📘

Paid Product

Data Integrations are 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.

1. Verify the Data Partner Accepts the Events You Want

The events Branch sends to third party data tools varies based on the events the partner supports as well as whether or not you've implemented the Branch SDK to measure said events.

All non-attributed events will be excluded. Branch also sends all the data that is attached to the link that drove the referred event. This will allow you to analyze which campaigns, channels, etc. are helping you acquire and engage users.

Data Integration Partner Branch Events Sent to Partner
24Metrics Fraudshield
  • • Install Events
  • • Click Events
  • • Commerce Events
Adform
  • • Install Events
  • • Commerce Events
  • • Custom Events
  • • Open Events
Adjust
  • • Click Events
Admost
  • • Install Events
Adobe Analytics
Adoya
  • • Install Events
  • • Commerce Events
Airship
Amplitude
  • • Install Events
  • • Open Events
  • • Reinstall Events
  • • Commerce Events
  • • Custom Events
AppMetrica
  • • Click Events
AppsFlyer
  • • Click Events
Appsee
  • • Install Events
Apptilaus - Subscription Analytics
  • • Install Events
  • • Open Events
  • • Commerce Events
  • • Custom Events
Apxor
  • • Install Events
  • • Open Events
  • • Commerce Events
  • • Custom Events
Backinapp
  • • Install Events
  • • Reinstall Events
  • • Open Events
  • • Commerce Events
  • • Custom Events
Batch
Barometric
  • • Install Events
  • • Open Events
  • • Custom Events
Bluecore
  • • Commerce Events
Braze
Bubbleye
  • • Click Events
  • • Install Events
  • • Open Events
  • • Commerce Events
  • • Custom Events
Chartable
  • • Install Events
  • • Commerce Events
  • • Custom Events
CleverTap
Convertro
  • • Click Events
  • • Install Events
  • • Reinstall Events
  • • Open Events
  • • Custom Events
Eulerian
  • • Click Events
  • • Impression Events
  • • Install Events
  • • Open Events
  • • Commerce Events
FollowAnalytics
  • • Install Events
Forensiq
  • • Click Events
  • • Install Events
Fraudscore
  • • Install Events
  • • Commerce Events
  • • Custom Events
Fraud Defense
  • • Install Events
Google Analytics
Google Firebase
Heap
iCubes Pro
  • • Install Events
  • • Commerce Events
Insider
  • • Install Events
  • • Commerce Events
  • • Custom Events
Iterable
  • • Install Events
  • • Open Events
  • • Commerce Events
  • • Custom Events
Kochava
  • • Click Events
Leanplum
Localytics
  • • Install Events
Machine Advertising
  • • Install Events
  • • Commerce Events
mFilterit
  • • Install Events
  • • Open Events
  • • Commerce Events
  • • Custom Events
Mixpanel
MobileAction
  • • Install Events
  • • Commerce Events
Moengage
  • • Install Events
mParticle
mParticle
myTracker
  • • Click Events
Netcore Smartech
  • • Install Events
  • • Commerce Events
  • • Custom Events
Neustar
  • • Install Events
  • • Open Events
  • • Commerce Events
  • • Custom Events
NotifyVisitors
  • • Install Events
  • • Commerce Events
  • • Custom Events
Scalarr
  • • Install Events
  • • Open Events
  • • Commerce Events
  • • User Lifecycle Events
  • • Custom Events
SearchAdsHQ
  • • Install Events
  • • Open Events
  • • Commerce Events
  • • Custom Events
Segment
Segment
Singular
  • • Click Events
Stitch
TrafficGuard
  • • Click Events
  • • Install Events
  • • Open Events
  • • Commerce Events
  • • Custom Events
Visual IQ
  • • Install Events
  • • Open Events
  • • Commerce Events
  • • Content
  • • User Lifecycle Events
WebEngage
  • • Install Events

2. Complete Data Integration Prerequisites

🚧

Developer Required

3. Retrieve Keys/Credentials From Your Partner

Find your Partner's Keys/Credentials. Later, you'll enter them into the Branch Dashboard.

Data Integration Partner Partner Keys/Credentials
24Metrics Fraudshield
  • • Client Key
Adform
  • • Client Tracking ID
Adjust
  • • iOS Tracker
  • • Android Tracker
Adobe Analytics
Airship
Amplitude
  • • iOS API Key
  • • Android API Key
AppMetrica
  • • iOS Tracking URL
  • • Android Tracking URL
Appsee
  • • API Key
  • • Token
AppsFlyer
  • • iOS App ID
  • • Android App ID
Apptilaus - Subscription Analytics
  • • App ID
Apxor
  • • Token ID
Backinapp
  • • iOS Partner ID
  • • Android Partner ID
Barometric
  • • iOS Property ID
  • • Android Property ID
Batch
Bluecore
  • • Token
Braze
CleverTap
Convertro
  • • Client Name
  • • Site ID
Eulerian
  • • Hostname
  • • Site
Forensiq
  • • Client Key
Fraud Defense
  • • App Key
Fraudscore
  • • Client Key
Google Analytics
Google Firebase
Heap
Insider
  • • Insider Partner Name
Iterable
  • • API Token
Kochava
  • • iOS Campaign ID
  • • Android Campaign ID
Leanplum
  • • App ID
  • • Production Key
Localytics
  • • iOS Attribution ID
  • • Android Attribution ID
Machine Advertising
  • • API Key
Mixpanel
MobileAction
  • • API Key
Moengage
  • • Moengage App ID
  • • Moengage App Key
mParticle
mParticle
myTracker
  • • App ID
Netcore Smartech
  • • Smartech App Key iOS
  • • Smartech App Key Android
Neustar
  • • Neustar Tag
NotifyVisitors
  • • Brand ID
  • • Secret Key
Scalarr
  • • Client Key
SearchAdsHQ
  • • Client ID
Segment
Segment
Singular
  • • ST Parameter from your tracking link
  • • H Parameter from your tracking link
Stitch
TrafficGuard
  • • API Key
  • • Organization ID
  • • iOS PropertyID
  • • Android PropertyID
WebEngage
  • • API Key
  • • Region

4. Enable the Integration

To enable the integration:

  1. In the left-hand navigation, under the Exports section, click Data Feeds.
  2. On the Data Feeds Manager page, click the Data Integrations tab at the top.
  3. Search for and click on your data partner.
  4. Provide the necessary credentials on the data partner's Export page.
  5. Click Enable.

5. Pass ID/Metadata to Branch (Partner Specific)

For some partners, you'll need to make sure to pass through the correct identifiers to the Branch SDKs. In order to do so, retrieve the ID from the partner SDK and pass this value to Branch using one of the following methods:

  1. setRequestMetadataKey() method of the Branch SDKs: iOS | Android
  2. setIdentity() method of the Branch SDKs: iOS | Android

Updated 18 days ago



Data Integration Implementation Guide


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.