---
"@context": https://schema.org
"@type": TechArticle
"@id": https://www.twilio.com/docs/segment/connections/destinations/catalog/branch-metrics#article
headline: Branch Destination
description: Connect the Branch destination to Segment to send identify and track events to Branch's mobile measurement and deep linking platform.
url: https://www.twilio.com/docs/segment/connections/destinations/catalog/branch-metrics
inLanguage: en
dateModified: 2026-07-15T17:40:17.000Z
author:
  "@type": Organization
  name: Twilio Developer Education Team
publisher:
  "@type": Organization
  name: Twilio
---

# Branch Destination

## Destination Info

* Accepts [Page](/docs/segment/connections/spec/page), [Identify](/docs/segment/connections/spec/identify), [Track](/docs/segment/connections/spec/track) calls.
* Refer to it as **Branch Metrics** in the [Integrations object.](/docs/segment/guides/filtering-data/#filtering-with-the-integrations-object)

### Components

* [iOS](https://github.com/BranchMetrics/Segment-Branch-iOS)
* [Android](https://github.com/BranchMetrics/Segment-Branch-Android)

## Connection Modes

[Learn more about connection modes.](/docs/segment/connections/destinations/#connection-modes)

### Device-Mode

* web: no
* mobile: yes
* server: no

### Cloud-Mode

* web: no
* mobile: no
* server: no

[Branch](https://branch.io/?utm_source=segmentio\&utm_medium=docs\&utm_campaign=partners) 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.

***

**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](https://docs.branch.io/integrations/segment-export/) to push additional data to Segment, and [data import integration](https://docs.branch.io/integrations/segment-import/) 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](https://web.archive.org/web/20191113225102//docs/connections/destinations/catalog/branch-metrics/).

***

This destination is maintained by Branch. For any issues with the destination, [contact the Branch support team](https://support.branch.io/support/home).

## Getting Started

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](http://branch.io/signup?bmp=segment) and follow the steps on their Dashboard to complete set up.
4. Copy your `Branch Key` from the Settings page of your [Branch dashboard](https://dashboard.branch.io/#/settings).
5. Paste the Branch Key in the destination settings and click **Save**.

### Identifiers for app events

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`

## Identify

Segment sends Identify calls to Branch to associate a user with their traits. To learn what the [Identify method](/docs/segment/connections/spec/identify/) does, see the Segment Spec. An example iOS call looks like:

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

## Track

Segment sends Track calls to Branch to record user actions. To learn what the [Track method](/docs/segment/connections/spec/track/) does, see the Segment Spec. An example iOS call looks like:

```swift
[[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 the Segment app without having to touch any code.

| Field         | Description                                                                                                                                                   | Required | Type   |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------ |
| Branch Secret | Required for server-side calls. Your Branch secret can be retrieved on the settings page of the \[Branch dashboard]\(https://dashboard.branch.io/#/settings). | No       | string |
| Branch Key    | Your Branch app key can be retrieved on the settings page of the \[Branch dashboard]\(https://dashboard.branch.io/#/settings).                                | Yes      | string |