Skip to contentSkip to navigationSkip to topbar
On this page
Looking for more inspiration?Visit the
(information)
You're in the right place! Segment documentation is now part of Twilio Docs. The content you are used to is still here—just in a new home with a refreshed look.

Branch Destination


Destination Info
  • Accepts Page, Identify and Track calls.
  • Refer to it as Branch Metrics in the Integrations object
Connection Modes
Device-modeCloud-mode
Web Web
Mobile Mobile
Server Server

Branch(link takes you to an external page) 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.

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(link takes you to an external page) to push additional data to Segment, and data import integration(link takes you to an external page) 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 the Archived version of this documentation(link takes you to an external page).


This destination is maintained by Branch. For any issues with the destination, contact the Branch support team(link takes you to an external page).


Getting Started

getting-started page anchor
  1. From the Segment web app, click Catalog.
  2. Search for "Branch Metrics" in the Catalog, select it, and choose which of your sources to connect the destination to.
  3. On Branch side you will need to sign up for a free Branch account(link takes you to an external page) and follow the steps on their Dashboard to complete set up.
  4. Copy your Branch Key from the Settings page of your Branch dashboard(link takes you to an external page).
  5. Paste the Branch Key in the destination settings and click Save.

Identifiers for app events

identifiers-for-app-events page anchor

Identifiers are required for events to be imported to Branch. You must include:

  • context.device.advertisingId and context.os.name and context.os.version, or
  • context.device.id and context.os.name and context.os.version

If you're not familiar with the Segment Specs, take a look to understand what the Identify method does. An example iOS call would look like:

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

If you're not familiar with the Segment Specs, take a look to understand what the Track method does. An example iOS call would look like:

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

Segment lets you change these destination settings from the Segment app without having to touch any code.

Property nameTypeRequiredDescription
Branch Secretstring

Optional

Required for server-side calls. Your Branch secret can be retrieved on the settings page of the Branch dashboard(link takes you to an external page).


Branch Keystring
required

Your Branch app key can be retrieved on the settings page of the Branch dashboard(link takes you to an external page).