Branch Destination


Branch empowers you to increase mobile revenue with enterprise-grade links built to acquire, engage, and measure across all devices, channels, and platforms. An industry-leading mobile measurement and deep linking platform, trusted by the most top ranking apps to increase efficiency and revenue.


As of November 2019, the Branch mobile SDKs for Segment are in maintenance mode, and will be refreshed in the second half of 2020.

Existing users of the Branch SDKs are unaffected, however new installations must implement the Branch native SDK separately. They can then enable Branch’s data export integration to push additional data to Segment, and data import integration to pull additional Segment data into the Branch dashboard.

The legacy instructions for implementing the Branch mobile SDKs for Segment have been removed from this documentation. If you need access to the removed sections, you can view them here.


This destination is maintained by Branch. For any issues with the destination, please contact the Branch support team.

This document was last updated on November 13, 2019. If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, please let us know!

Getting Started

The first step is to make sure Branch Metrics supports the source type and connection mode you’ve chosen to implement. You can learn more about what dictates the connection modes we support here.

Web Mobile Server
📱 Device-mode
☁️ Cloud-mode
  1. From your Segment UI’s Destinations page click on “Add Destination”.
  2. Search for “Branch Metrics” within the Destinations Catalog and confirm the Source you’d like to connect to.
  3. On Branch side you will need to sign up for a free Branch account and follow the steps on their Dashboard to complete set up.
  4. Copy your Branch Key from the Settings page of your Branch dashboard.
  5. Paste the Branch Key in the destination settings and click Save.

Identify

If you haven’t had a chance to review our spec, please take a look to understand what the Identify method does. An example iOS call would look like:

[[SEGAnalytics sharedAnalytics] identify:@"12091906-01011992"
                                traits:@{ @"email": @"john.doe@example.com" }];

Track

If you haven’t had a chance to review our spec, please take a look to understand what the Track method does. An example iOS call would look like:

[[SEGAnalytics sharedAnalytics] track:@"Article Completed"
                           properties:@{ @"title": @"How to Create a Tracking Plan", @"course": @"Intro to Analytics" }];

Settings

Segment lets you change these destination settings from your Segment dashboard without having to touch any code.

Branch Secret

Required for server-side calls. Your Branch secret can be retrieved on the settings page of the Branch dashboard.

Branch Key

Your Branch app key can be retrieved on the settings page of the Branch dashboard.

Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account