Access the branch.io dashboard at: https://dashboard.branch.io/quick-links/manager
Admins can add new branch.io users here: https://dashboard.branch.io/account-settings/team
To create a new deeplink, click the create button in the top right corner of the Link Hub dashboard. To duplicate a previously created deeplink, click the ... button at the end of the deeplink entry and select "Duplicate".
Give your new deeplink a "Link title" to easily identify it. Next, choose a "Link Alias" which customizes the deeplink URL. If left blank, a randomly generated combination will be created. Once saved, the alias cannot be changed.
NOTE: If you choose a customized URL ending, make sure it has not been used before — branch.io doesn't check for duplicates. Deeplinks are case sensitive. We advise using only lowercase and "-" to separate words.
To organize your deeplinks or create UTM additions, you can make use of the available options. Tags can help categorize deeplinks so not all info needs to be in the title.
This section defines what happens on a user's device after clicking your deeplink, depending on the install status of your app:
App installed: Users are directed into the app on mobile devices.
App not installed (mobile): Default redirect is the device's app store / play store.
Desktop: You can list a specific URL on your website (e.g., the corresponding page of the performance) or a general URL about the app.
If you wish to send mobile users to your website instead of their app store, you can change the iOS and Android redirects to a Web URL. This might be applicable for newsletters where your main goal is not to make users install the app.
When creating a new link, add the key/value pair lines for each of the listed values. When duplicating a link, all previously used keys/values will be listed — make sure to exchange any old IDs.
Mandatory Keys:
deeplink_url = path into the app
$deeplink_path = path into the app
$ios_deeplink_path = path into the app
$android_deeplink_path = path into the app
$canonical_url = corresponding web URL on your website
Path into the app:
performances/<eventid> — Path to a specific production. e.g.: performances/123
booking/<eventid>/<performanceid> — Path to a specific performance booking page. e.g.: booking/123/456
events/<categoryid> — Path to a category of productions. e.g.: events/7890
categories/<categoryid> — Path to a category of other categories. e.g.: categories/9870
subscription-sign-up/<subscriptionId> — Path to membership registration info. e.g.: subscription-sign-up/1
info-page/<categoryid> — Path to a category with action type "Flexible Route in the App"
This section provides additional information for the presentation of your deeplink when sent in messengers or emails where link previews are enabled. Add any information and content to your link preview.
Double check all previous sections before clicking "Create Link" to finalize.
Except for the link URL, all data (path, redirects, link preview) can be changed after creation by clicking the three-dot button.
If you need to change the actual deeplink URL, you must create a new deeplink (duplicate the previous one).
Always test every deeplink before using it publicly, if possible on devices with and without the app installed.
We advise against deleting deeplinks. You can archive them instead to clean up your dashboard.
We have provided templates for:
Start screen of the app (template_general_link)
Single production (template_event)
Booking options for performance date (template_bookingopt)
Category of events (template_cat_events)
Category of categories (template_cat_categories)
Info-page (template_info-page)
Membership sign up (template_membership_signup)
To duplicate any template, click the three-dot button next to the deeplink. Make sure to correct the IDs before using your final deeplink.
Your dashboard lists all created deeplinks with metrics in the defined time span (default: 7 days). Standard metrics show Clicks, Installs, Opens, Web Session starts. By default, the "unique" checkbox is selected — uncheck it to see full numbers.
Navigate to Analysis > Overview > Sources. Use "marketing title" in the Compare by filter to see all created deeplinks. Check the "Organic" checkbox and choose a date filter.
Customize the table by clicking the [||] sign and selecting relevant metrics. Use "+ Create View" to save your default filters and columns.
branch.io allows downloading data up to 6 months into the past with the "Export" button. Set the desired time span and customize your overview table with all relevant metrics before exporting.
For detailed exports of singular metrics, go to the "Exports" menu section. Choose any one or all metrics, or create your own custom export.
