Overview
Welcome to Branch Activation, our enterprise solution for creating custom QR Codes and short links to activate customers across web and app.
With Activation, you can create shortened web and app links, as well as custom QR codes, that leverage the full power of the Branch Growth Platform.
Activation simplifies how you generate branded web links, app links, and QR codes, providing dedicated click insights and exports without requiring complex SDK setups for your web campaigns.
The information and resources in this guide will help you:
Migrate your existing links from another service to Branch
Test and manage your links
View and export your data
How Branch Links work
Web Links are web-only short links that work everywhere. App Links are deep links that take users to specific pages in your app. Web and App Links look the same (yourbrand.com/slug or yourbrand.app.link/slug) depending on if you choose to use a custom domain or a Branch-provided app.link domain.
Expected behavior for Web Links
If your end user does not have your app installed, or if you don’t have an app, the link will open in their default web browser. If they do have your app downloaded, the link will open in your app through an in-app web view.
Expected behavior for App Links
If your end user has your app installed, the App Link will deep link to the specific app page you’ve chosen. If they do not have your app installed, they will taken to the redirect destination for non-app users which can be configured as a web page, a Branch Deepview, or the app store listing to download the app.
Before you begin
Determine your scenario
Complete the following tasks to determine the correct migration scenario for your use case:
Identify whether you will be using a custom domain or the Branch provided app.link domain. Read the “Add a custom domain” section below if you plan to use a custom domain.
Your title goes here
The steps in this article only apply to links using a custom domain that you own. Branch does not support migrating links that use a domain that you don’t own (for example, bit.ly). Links that do not use a custom domain that you own must be recreated in Branch using the provide app.link domain or a custom domain.
Identify the types of links you will be migrating: web links. app links, or both. Read the “How Branch Links work” section above to learn more about each link type. If migrating app links, the Branch SDK is a required component to enable deep linking into your app.
Set up your Branch Dashboard
Get a new Branch Dashboard (if you’re a new user) or use your existing Branch Dashboard (if you’re an existing user). If you need a new Branch Dashboard, reach out to your Branch Account Owner to create a separate dashboard for migrated Branch links.
Add a custom domain (optional)
Read our Basic Link Configuration article to learn how to set up a custom domain to use for Branch Links.
Caution
SSL certificate setup will cause about 5 minutes of downtime where users will see an error page, followed by temporarily redirecting to the default domain.
Migrate your links
Complete the steps in this section to migrate your links to Branch.
Step 1: Export your links to a CSV
Export the links that are stored in your existing linking service. Transfer these links to a Branch-compliant CSV or change the existing CSV to align with the fields in the sample CSV below.
Step 2: Import your links to Branch
Branch supports two migration paths. We recommend using the self-serve path shown in this guide if a 5-15 minute downtime is possible. Generating a CSR and updating the certificate (zero downtime) will involve Branch support and may take time.
Note
The steps in this article only apply to links using a custom domain that you own. Branch does not support migrating links that use a domain that you don’t own (for example, bit.ly). Links that do not use a custom domain that you own must be recreated in Branch using the provide app.link domain or a custom domain.
Upload your CSV to Branch using “Method 2: Bulk Quick Links in the Branch Dashboard” in our Create Web Links article. You can create both app and web links using the same method.
Alternatively, you can create individual links in the Branch Dashboard or use the Deep Linking API to create links programmatically (requires developer support).
Step 3: Test your links
Use Link Validator to test how your links will behave based on who your end user is and where they are clicking the link from.
Tip
Once you’ve confirmed that your Branch Links are working and your links from your other service are no longer receiving traffic, you can deprecate them in that service.
Export campaign data
With Activation, you can export your campaign data using Dashboard Exports, Branch’s Advanced Data Feeds, or one of the APIs included in your package.
Branch Dashboard
Export data as a CSV or JSON file manually from the Branch Dashboard using Dashboard Exports. Choose between Daily or Custom exports to identify the best configuration of your export.
Included APIs
Activation includes the Daily Exports API, Custom Exports API, Query API, Aggregate API, and Cohort API. Use these APIs to export specific data and analytics.
Available export fields
The following table shows the export fields that are available with Activation:
Field name |
|---|
di_match_click_token |
event_timestamp |
hash_version |
id |
last_attributed_touch_data_custom_fields |
last_attributed_touch_data_dollar_marketing_title |
last_attributed_touch_data_plus_current_feature |
last_attributed_touch_data_plus_touch_id |
last_attributed_touch_data_plus_url |
last_attributed_touch_data_plus_via_features |
last_attributed_touch_data_plus_web_format |
last_attributed_touch_data_tilde_campaign |
last_attributed_touch_data_tilde_campaign_id |
last_attributed_touch_data_tilde_campaign_type |
last_attributed_touch_data_tilde_channel |
last_attributed_touch_data_tilde_customer_campaign |
last_attributed_touch_data_tilde_feature |
last_attributed_touch_data_tilde_id |
last_attributed_touch_data_tilde_keyword |
last_attributed_touch_data_tilde_keyword_id |
last_attributed_touch_data_tilde_keyword_match_type |
last_attributed_touch_data_tilde_placement |
last_attributed_touch_data_tilde_stage |
last_attributed_touch_data_tilde_tags |
last_attributed_touch_timestamp |
last_attributed_touch_timestamp_iso |
name |
origin |
request_id |
timestamp |
timestamp_iso |
user_data_brand |
user_data_browser |
user_data_build |
user_data_cpu_type |
user_data_cross_platform_id |
user_data_developer_identity |
user_data_environment |
user_data_geo_city_code |
user_data_geo_city_en |
user_data_geo_country_code |
user_data_geo_dma_code |
user_data_http_referrer |
user_data_installer_package_name |
user_data_internet_connection_type |
user_data_ip |
user_data_language |
user_data_limit_ad_tracking |
user_data_model |
user_data_opted_in |
user_data_os |
user_data_os_version |
user_data_os_version_android |
user_data_past_cross_platform_ids |
user_data_platform |
user_data_prob_cross_platform_ids |
user_data_screen_height |
user_data_screen_width |
user_data_user_agent |
Advanced Data Feeds
Advanced Data Feeds is Branch’s suite of tools for exporting data which can be added on to any Branch package. Use these tools if you want to export your data to other analytics services.
To explore these concepts further, check out these blog posts:
Manage and maintain links
Use LinkHub to create, manage, and deploy links at scale. You can also view click analytics for your links on the Overview page.
Use Link Templates to manage the bulk creation of your app and web Quick Links. A Link Template can be used to automatically apply attributes while creating Quick Links. This can save you time and reduce the potential for errors when creating Quick Links.
FAQ
I am currently using links under a domain that I don’t own. Can I migrate those links to Branch?
No. You cannot migrate any links that use a domain that you don't have ownership of (for example, bit.ly). Links from a domain you don’t own would need to be recreated as Branch links with an app.link or custom domain.
Will my existing link analytics carry over to Branch?
No. Link analytics for your Branch Links will begin as soon as they’re created.
Can I migrate my shortened links from a different tool to the same Branch Dashboard I already use for existing Branch campaigns?
Yes. You can use the same Branch Dashboard. Review the following examples to learn more about what to expect.
Change | Example | Behavior |
|---|---|---|
App.link to custom domain | yourbrand.app.link to yourbrand.com |
|
Custom domain to custom domain | app.youbrand.com to yourbrand.com |
|
What should I do if I don’t have the team or resources needed to implement Activation?
If your team lacks the capacity or expertise to implement the solution, our Professional Services team can provide hands-on, tailored support to ensure a successful deployment from start to finish. We offer advisory hours to give you access to our consultants for strategic guidance, technical support, or specific project deliverables.
Get Professional Services support
Branch’s Professional Services team is available on a paid basis for your onboarding setup and advisory, implementation enhancement, and large strategic project execution needs. Reach out to your Branch Account Owner for more information on how Professional Services can support your Activation product usage.