TABLE OF CONTENTS
- What is a Deeplink?
- Get Started: Creating Deeplinks
- Tracking Click Statistics for Deeplinks
- Additional Deeplink Resources
Driftscape equips users with powerful tools for seamless navigation, but when you need to guide your visitors to specific points of interest, our deeplink feature takes it to the next level. This feature allows you to create targeted links that direct visitors exactly where you want them to go, enhancing their experience and engagement.
What is a Deeplink?
Deeplinks are a powerful tool for promoting your content in Driftscape. These web links will direct your visitors directly to the content you want them to see, regardless of the device they are using or whether or not they have already installed the app. They can point to specific POIs, sets of POIs, and much more.
Deeplinks work, even if the app is not yet installed on the user’s phone. When a user clicks the deeplink (or scans the QR code containing the deeplink URL), it will bring them to the app store and allow them to install Driftscape, when it is not yet installed. After the app is installed, opened, and user onboarding completed, then the deeplink action is taken, highlighting your content. Deeplinks also work in Driftscape for Web, if a user clicks the URL link from their desktop computer instead of their mobile phone or tablet.
Full deeplink functionality is described below.
Use deeplinks in your social media channels, web site, emails, marketing efforts, and even use them for QR Codes you can print and post at locations to encourage users to scan on-site!
Deeplinks can be setup to do many different things, including:
Display only your organization’s content
Display a set of selected content
Open a particular POI [Point of Interest], such as a tour or place
On Mobile or Desktop, with or without Driftscape installed, Deeplinks will work to point your visitors to the content you want them to see:
When used from a mobile device, if Driftscape is installed, then the app is opened and the deeplink action is performed to showcase your content.
When used from a mobile device and Driftscape is not installed yet, then the user is taken to the app store, where they can download and install the app. After the app is installed and the initial content is synced to our server, the deeplink action will occur.
When used from a desktop browser, Driftscape for Web is opened. Driftscape for Web also supports most deeplink actions noted below, including opening a POI or highlighting your organization’s content.
You can scan deeplink QR Codes from Driftscape AR Mode in iOS and Android. This will perform the deeplink action as well. This is great for indoor spaces or exhibits where you can attach QR Codes on a place near the POI.
Organization deeplinks opened from a desktop browser will open Driftscape for Web and perform the same action (where supported, see the action notes below).
Get Started: Creating Deeplinks
Step 1: Create your Deeplink Generator sheet
Make a COPY of this Deeplink generator template for your organization.
Step 2: Understanding your Deeplink Generator sheet
Here is an example of what a deeplink looks like: this is the Base Branch deeplink for a sample organization (in this case, Driftscape Gems - Canada).
https://driftscape.app.link/yHwwr9ciZtb
Your deeplink will be similar, with a different unique suffix at the end (the highlighted portion).
The general format of a custom deeplink is as follows (the square brackets indicate a variable, do not actually use brackets in the deeplink URL)
https://driftscape.app.link/[organization_id]?driftscape_action=[action][&[parameter]=[value]]*
For example:
Most actions typically only have one parameter, but some actions may require two or more parameters.
The deeplink actions that are available are described under 'Action & Parameter' in the section below.
The following walks you though the various columns you will see on the Deeplink Generator Sheet, and explains how to use each one.
Description of deeplink
Use this column for internal notes, so your team can easily identify the purpose of each deeplink.
Base Branch deeplink
Each organization in Driftscape gets a unique base deeplink (URL) they can customize themselves to promote their content. These can be used to open a POI, select all the content in your organization, and much more.
Ask your Driftscape Customer Success representative to get your organization’s deeplink base URL. Please contact support@driftscape.com.
Action & Parameter
In these columns (‘Action’ and ‘Parameter’), specify the action you want each deeplink to perform. Below, you'll find a list of actions and corresponding parameters along with their definitions.
Note: The driftscape parameter ‘driftscape_action’ can be shortened to ‘a’. Text in square brackets references the short form for those respective actions. They are useful to shorten the deeplink URL for use with QR Codes to ensure the image is small and will scan properly. These are used in the Generated deeplink- short form column of the spreadsheet.
open_feature[f]: will start Driftscape and open the POI details you direct it to with the UUID.
Parameter: Set to ‘driftscape_feature_uuid’. This will work regardless of the current filter settings. This action is fully supported in Driftscape for Web.
select_org[s]: will start Driftscape, and turn off all categories and organizations and select only this organization, return to main map mode, clear any existing search, zoom in on the POI for the organization.
Parameter: Set to ‘driftscape_org_id’. This action is supported in Driftscape for Web, but other organization content may be visible as well (depending on the base deeplink content): the map is zoomed to encompass the selected organization.
open_feature_map[m]: will start Driftscape in map view with the POI in close-in view and the map callout displayed.
Parameter: Set to ‘driftscape_feature_uuid’. This will turn on the parent organization for this POI, and disable search filtering, if required to show the POI on the map. In Driftscape for Web, this action is the same as the open_feature action.
Parameter 2 (optional): set ‘open_feature_map_select_org[s]’ to 1. This will cause the features parent organization to be selected first before opening the POI.
select_orgs[z]: will start Driftscape, and turn off all categories and organizations and select only these organizations (that is, multiple organizations), return to main mode, clear any existing search, zoom in on the POI for the organizations.
Parameter: Set to ‘driftscape_org_ids’ - comma separate list of organization. This action is not supported in Driftscape for Web.
open_search[e]: go to main mode, turn on all categories and orgs, clear any existing search, enter the specified search filter terms (see next section: "Here are the parameter values referenced above"), and zoom in on the filtered POIs. This action is supported in Driftscape for Web.
Parameter: Set to ‘search_filter[f]’
Parameter 2 (optional): set to ‘driftscape_org_id’. This will select the noted organization first, before opening the search.
open_search_list[l]: same as open_search, but also switches to list view. This is useful to tag select content with a unique search term (like ‘TorontoCurrentEvents’), and then use this to show that sub-content in list view. Add the tag to the content itself, in the description box (it will be visible to users).
Parameter: Set to ‘search_filter[f]’
Parameter 2 (optional): set to ‘driftscape_org_id’. This will select the noted organization first, before opening the search.
open_search_plain[r]: Zooms in on the filtered POIs. Does NOT change any current non-search filter settings.
Parameter: Set to ‘search_filter[f]’
Parameter 2 (optional): set to ‘driftscape_org_id’. This will select the noted organization first, before opening the search.
select_category[g]: Specify the category id with the category parameter below. Clears all search and other filters. The ‘mode’ parameter is supported with this action. This action does nothing in Driftscape for Web.
Parameter: Set to ‘category[c]’.
subscribe_org[c]: similar to open_org in that it will open the organization details, this will also subscribe the user to that organization for push notifications, if supported for that organization. This action is not supported in Driftscape for Web.
org_events[v]: will start Driftscape, and turn off all categories and organizations and select only this organization, return to main list mode, clear any existing search, and select only events (turns off places and tours). Use this to display the ‘current events’ for an organization.
Parameter: Set to ‘driftscape_org_id’. Note: This action does nothing in Driftscape for Web.
open_org[o]: will start Driftscape and open the details for an organization.
Parameter: Set to ‘driftscape_org_id’ and the numeric integer org ID. This action is supported in Driftscape for Web.
Open_feature_scroll[u]: same as open_feature, but scrolls the opened POI web view to the bottom of the content. (this can also be achieved by entering “y” in the “Scroll to Bottom?” column)
Parameter Value
While the parameter column establishes the type of parameter for this deeplink, the Parameter Value column establishes the specific parameter. For example if your parameter is driftscape_feature_uuid, you will need to specify the POI you would like your deeplink to open, by finding the feature UUID for that specific POI, and entering it in the Parameter Value column.
Below you will find instructions for entering the correct Parameter Value according to the Parameter you have specified.
driftscape_feature_uuid[i]: from the CMS, find the POI you want to promote. Edit the POI (or tour stop), and at the top you will see the UUID. Alternatively, you can use the short POI id, which is displayed in the URL itself when you open the POI. These screenshots of an edited POI show where to get the UUID and POI id:
OR Alt ID
driftscape_org_id[o]: the organization ID. Find the organization in the CMS, and the org ID is listed in the table. 
driftscape_org_ids[z]: enter multiple integer organization ids (as above), each item separated by a comma. Find the organizations in the CMS, and the org id is listed in the CMS tables, as shown in the screenshot above.
search_filter[f]: the search terms to apply. Be careful with certain symbols in the search text: you may have to URL encode the values in the parameter (for example, ‘&’ or ‘?’). Generally, if just using alphanumeric characters and spaces, you can just add them. The generator spreadsheet automatically URL encodes the text for you.
category[c]: the name of the category to select. Provide this parameter with the ‘select_category’ action.
scroll_to_bottom[l]: use with the ‘open_feature’ action. Set to ‘1’ to cause the opened POI to scroll to the bottom of the content. Otherwise, the POI is opened to the top of the content.
Parameter 2 & Parameter 2 Value
Some actions require or allow for more than one parameter..only set in those cases (rarely used).
Toast Message
(Optional) Enter a brief message (under 200 characters) that will briefly appear at the bottom of the screen to inform users of what has been presented. This can be combined with any deeplink action. Note that certain symbols (like ‘&’ or ‘?’) are URL encoded in the parameter. This feature is supported only in the mobile apps and will be ignored in Driftscape for Web.
Mode
This tells the mobile app and/or the web app what mode it should display the action in. Choices are:
m (map view)
l (list view)
a (ar mode).
Note: This option works with only these actions: select_org, open_search, open_search_list, show_all, and select_category.
Scroll to bottom?
This can be used with the ‘open_feature’ action. Set to ‘y’ to cause the opened POI to scroll to the bottom of the content. Otherwise, the POI is opened to the top of the content.
Works in web app?
Do not edit this column. All gray columns indicate formulas that you should not change. This column indicates if the deeplink you have entered will work in the web app.
Generated deeplink - short form
Do not edit this column. All gray columns indicate formulas that you should not change. This column will display the short form of the deeplink that has been generated according to the information you have entered in the preceding columns. Use this link for Generating QR Codes. This will create a smaller clearer QR code image for ease of scanning. You can also use it on social media platforms where character count is limited. Simply copy and paste this generated link.
Generated deeplink - long form
Do not edit this column. All gray columns indicate formulas that you should not change. This column will display the long form of the deeplink that has been generated according to the information you have entered in the preceding columns. You can use this version of the link anywhere you want to share your content! Simply copy and paste this generated link.
Both the short form and long form generated deeplinks have the same functionality. The only difference is the length. Always test your deeplinks before promoting them to your visitors. Your content needs to be live in the Driftscape app before you can test your deeplinks.
Step 3: Using the Generated Deeplinks
Once you have tested your deeplinks, you can begin using them to promote your content to your visitors. Simply cut and paste the links from the generated deeplink columns of your deeplink generator spreadsheet. The short form of the link is ideal for QR codes, or anywhere were you have a limited character count, otherwise use the long form. 
We’ll use an example deeplink that directs the user to this tour:
Short form: https://driftscape.app.link/yHwwr9ciZtb?a=f&i=211699
Long form: https://driftscape.app.link/yHwwr9ciZtb?a=open_feature&driftscape_feature_uuid=211699
Feel free to test these links on different devices.
Generated deeplinks can be shared anywhere, on your website, in social media posts, or in the example below by email.
Clicking the deeplink from a mobile device
If you received the email and clicked the link on your mobile devices, it would open the Driftscape mobile app and display the specified content. If a user does not yet have the app installed, they will first be directed to download it and then the specified content will be displayed.
Clicking the deeplink from a computer
If you click the same deeplink from a computer, your browser will open Driftscape for Web, and display the same tour.
Tracking Click Statistics for Deeplinks
Driftscape does not collect or provide any tracking data to customers for deeplinks. If you want to track the performance of the deeplinks in your own campaigns, you should do that in the marketing tools you use with them. For example, if you are using the deeplinks in a social media campaign such as Facebook, then track the statistics there. Or, if you are using the deeplink in a web page, then use Google Analytics with an event tag to track performance.
Our deeplinks will work with third-party marketing tools that ‘wrap’ the URL for tracking purposes. For example, most email campaign tools will replace the link with a custom link that redirects to the associated deeplink. This will work properly on Android, iOS and Driftscape for Web.
If you need further assistance, please contact support@driftscape.com
Additional Deeplink Resources
For more information, please visit:
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article