Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EA user level click tracking for shortened SMS links #4627

Merged
merged 2 commits into from
Jan 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 0 additions & 116 deletions _docs/_hidden/private_betas/link_shortening.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ article_title: Link Shortening
page_order: 5
description: "This reference article covers how to enable link shortening in your SMS messages and some frequently asked questions."
page_type: reference
alias: "/link_shortening/"
tool:
- Campaigns
channel:
Expand All @@ -16,15 +17,27 @@ channel:

## Overview

Link Shortening and click tracking can be enabled at the [message variant-level]({{site.baseurl}}/user_guide/engagement_tools/testing/multivariant_testing/#step-1-create-your-campaign) in both campaigns and Canvases. Links will be shortened using Braze’s shared short domain ([brz.ai](http://brz.ai)) with a length of between 20-21 characters. An example URL may look something like this: `https://brz.ai/8jshX`
Link shortening and click tracking can be enabled at the [message variant-level]({{site.baseurl}}/user_guide/engagement_tools/testing/multivariant_testing/#step-1-create-your-campaign) in both campaigns and Canvases.

{% alert important %}
Shortened links with advanced tracking are currently in early access. Contact your Braze customer success manager if you're interested in participating in the early access.
{% endalert %}

The length of the URL will be determined by the type of tracking that is enabled:
- **Basic tracking** enables campaign-level click tracking. Basic links will have a length of between 20-21 characters.
- **Advanced tracking** enables campaign-level and user-level click tracking. Links with advanced tracking are longer by up to 7 characters and allow you to create segments of users who have clicked on URLs. Advanced links will have a length of between 27-28 characters.

Links will be shortened using Braze’s shared short domain ([brz.ai](http://brz.ai)). An example URL may look something like this: `https://brz.ai/8jshX` (basic) or `https://brz.ai/8jshX/2dj8d` (advanced). Refer to the [Testing](#testing) for more information.

Shortened URLs will be valid for one year from the date they were created.

To enable Link Shortening, ensure the Link Shortening toggle in the message composer is enabled.
### Enabling link shortening

To enable link shortening, ensure the link shortening toggle in the message composer is enabled. From there, choose whether to use Basic or Advanced by selecting the respective radial button.

![][1]

For Braze to recognize URLs, they must start with _http://_ or _https://_. When a URL is recognized, the **Preview** pane will update with a placeholder URL. Note that the character count in the **Compose** tab excludes all personalization of link shortening.
For Braze to recognize URLs, they must start with _http://_ or _https://_. When a URL is recognized, the **Preview** pane will update with a placeholder URL. Braze will estimate the length of the URL after shortening, but a warning will prompt you to select a test user and save the message as a draft for a more accurate estimate.

![][3]

Expand All @@ -44,12 +57,31 @@ Liquid personalization and shortened URLs are templated on the **Test** tab afte

## Click tracking

When Link Shortening is enabled, the SMS and MMS performance table include a column titled **Total Clicks** that shows a count of click events per variant and an associated click rate. For more details on SMS metrics, see [SMS message performance]({{site.baseurl}}/user_guide/message_building_by_channel/sms/sms_campaign_analytics/#message-performance).
When link shortening is enabled, the SMS and MMS performance table include a column titled **Total Clicks** that shows a count of click events per variant and an associated click rate. For more details on SMS metrics, see [SMS message performance]({{site.baseurl}}/user_guide/message_building_by_channel/sms/sms_campaign_analytics/#message-performance).

![][4]

The Historical Performance and SMS Overview chart also includes an option for **Total Clicks** and shows a daily time series of click events.

## Retargeting Users

Retarget users who have clicked campaigns with advanced tracking links.
Only campaigns that have advanced tracking enabled will appear in the following dropdowns:

##### Retarget users who have clicked a specific SMS Campaign:
1. Create a segment using the **Clicked/Opened Campaign** filter.
2. Select **clicked sms**.
3. Choose the desired campaign.

![][5]

##### Retarget users who have clicked a specific Canvas Step:
1. Create a segment using the **Clicked/Opened Step** filter.
2. Select **clicked sms**.
3. Choose the desired Canvas and Canvas step.

![][6]

## Frequently asked questions

#### How long are the shortened URLs?
Expand All @@ -62,7 +94,7 @@ No. Currently, only static URLs are shortened.

#### Are the links I receive when test sending real URLs?

If the campaign has been saved as a draft before test sending, yes! Otherwise, it is a placeholder link.
If the campaign has been saved as a draft before test sending, yes! Otherwise, it is a placeholder link. Note that the exact URL sent in a launched campaign may differ from the one sent via a test send.

#### Does the Braze SDK need to be installed in order to shorten links?

Expand All @@ -86,9 +118,14 @@ One year.

#### Will Link Shortening work with deep links or universal links?

Link Shortening will only shorten static URLs that start with _http://_ or _https://_. It is not advised to further shorten generated universal links (from providers such as Branch or Firebase) as this may break the attribution or redirect of those tools.
Link shortening will shorten any static URLs that start with _http://_ or _https://_. However, it is not advised to further shorten generated universal links (from providers such as Branch or Appsflyer) as this may break the attribution or redirect of those tools.

[1]: {% image_buster /assets/img/link_shortening/shortening1.png %}
[2]: {% image_buster /assets/img/link_shortening/shortening2.png %}
[3]: {% image_buster /assets/img/link_shortening/shortening3.png %}
[4]: {% image_buster /assets/img/link_shortening/shortening4.png %}
[4]: {% image_buster /assets/img/link_shortening/shortening4.png %}
[5]: {% image_buster /assets/img/sms/retargeting5.png %}
[6]: {% image_buster /assets/img/sms/retargeting4.png %}
[11]: {% image_buster /assets/img/sms/link_shortening10.png %}
[13]: {% image_buster /assets/img/link_shortening/shortening3.png %}