Add Custom Variables to Invitation Links or Site Intercept and Feedback Tab code

Use these steps to add custom variables to Invitation Links or Site Intercept and Feedback Tab code.

This article applies to: UserZoom

✅ Plan Availability: Check below for more info
👥 User roles: Owner, Admins, and Researchers
For more information, see our article on how to find your plan and user role.

 

On this page:

• About custom variables
• Find custom variables in the Results
• Add custom variables to Invitation Links
• Add custom variables to Site Intercepts
• Add custom variables to Feedback tabs
• Add custom variables when triggering a study in a Mobile app

 

---

 

About custom variables

• Use custom variables to store additional information for each participant. For example, a unique user ID, demographics, etc.).
• The custom variable functionality is available for:
  • Invitation Links: Multi-Use links, Panel links, and Unique links
  • Site Intercepts: Only regular Site Intercepts, Not Permanent Site Intercepts
  • Feedback tabs: Only regular Site Intercepts, Not Permanent Site Intercepts

 

Limitations

• There is no limit to how many variables can be sent.
• These variable names are already in our system and can't be used:
  

  io r

  iu uc

  ln uzid

  tic

• These characters can't be used in variable names or values: . _ ~ : / ? # [ ] @ ! $ & ' ( ) * + , ; =
• Keep Invitation Link URLs under 2048 characters to ensure they work in all browsers.

 

 

Find custom variables in the Results

• Variables and their values are stored for participants who complete the study.
• This data can be found in the exports and is not available in the Results section.
• In the Raw Data, variables are found in the Qualitative_Variables tab and the values are found in the Qualitative_Data tab.

 

 

Add custom variables to Invitation Links

✅ Plan Availability: All plans

1. After the UserZoom invitation link, add a question mark (?).
2. Add the name of the variable followed by the equal symbol (=) and the value of the variable (For example, 'gender=female’).
3. If more than one variable is added, use an ampersand (&) to separate each variable and value.

https://s.userzoom.com/m/MSBDMjhTODgg?gender=female&country=uk

• • If you use custom variables in Panel Links in combination with Redirect URLs, the custom variable (the part of the Panel Link after the question mark) is automatically added to the Redirect link.
  • Example: If the Panel Link is https://s.userzoom.com/p/MSBDMjhTODgg/participant12345?gender=female&country=uk, the system automatically appends "?gender=female&country=uk" to the Redirect URL and becomes http://www.userzoom.com/?gender=female&country=uk.

 

 

Add custom variables to Site Intercepts

✅ Plan Availability: Corporate, Essentials, Professional, International, and Premium

There are two options to add custom variables to Site Intercepts. For both options, you have to add a separate line per custom variable.

Option 1

<script type="text/javascript">//<![CDATA[
var _uzactions= _uzactions|| [];
_uzactions.push(['_setID', 'XXXXXXXXXXX']);
_uzactions.push(['_setSID', 'YYYYYYYYYY']);
_uzactions.push(['_setCustomVar',['test1','value_test1']]);
_uzactions.push(['_setCustomVar',['test2','value_test2']]);
_uzactions.push(['_start']);
(function() {
var uz = document.createElement('script'); uz.type = 'text/javascript'; uz.async = true; uz.charset = 'utf-8';
uz.src = ('https:' == document.location.protocol ? 'https://' : 'http://') + 'ZZZZ.userzoom.com/trueintent/js/uz_til.js?cuid=’#######################’;
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(uz, s);
})();
//]]></script>

Option 2

<script type="text/javascript">//<![CDATA[
var _uzactions= _uzactions|| [];
_uzactions.push(['_setID', 'XXXXXXXXXXX']);
_uzactions.push(['_setSID', 'YYYYYYYYYY']);
_uzactions.push(['_setCustomVar',{'name':'test3','value':'value_test3'}]);
_uzactions.push(['_setCustomVar',{'name':'test4','value':'value_test4'}]);
_uzactions.push(['_start']);
(function() {
var uz = document.createElement('script'); uz.type = 'text/javascript'; uz.async = true; uz.charset = 'utf-8';
uz.src = ('https:' == document.location.protocol ? 'https://' : 'http://') + 'ZZZZ.userzoom.com/trueintent/js/uz_til.js?cuid=’#######################’;
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(uz, s);
})();
//]]></script>

 

 

Add custom variables to Feedback tabs

✅ Plan Availability: Corporate, Essentials, Professional, International, and Premium

There are two options to add custom variables to Feedback Tabs. For both options, you have to add a separate line per custom variable.

 

Option 1

<script type="text/javascript">//<![CDATA[
_uzactfeed = window._uzactfeed || [];
_uzactfeed.push(['_setID', 'XXXXXXXXXXX']);
_uzactfeed.push(['_setSID', 'YYYYYYYYYY']);
_uzactfeed.push(['_setCustomVar',['test1','value_test1']]);
_uzactfeed.push(['_setCustomVar',['test2','value_test2']]);
_uzactfeed.push(['_start']);
(function() {
var uz = document.createElement('script'); uz.type = 'text/javascript'; uz.async = true; uz.charset = 'utf-8';
uz.src = ('https:' == document.location.protocol ? 'https://' : 'http://') + 'ZZZZ.userzoom.com/feedback/js/uz_feed_us.js?cuid=7540AB346CCDE41180C90050569444FB';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(uz, s);
})();
//]]></script>

 

Option 2

<script type="text/javascript">//<![CDATA[
_uzactfeed = window._uzactfeed || [];
_uzactfeed.push(['_setID', 'XXXXXXXXXXX']);
_uzactfeed.push(['_setSID', 'YYYYYYYYYY']);
_uzactfeed.push(['_setCustomVar',{'name':'test3','value':'value_test3'}]);
_uzactfeed.push(['_setCustomVar',{'name':'test4','value':'value_test4'}]);
_uzactfeed.push(['_start']);
(function() {
var uz = document.createElement('script'); uz.type = 'text/javascript'; uz.async = true; uz.charset = 'utf-8';
uz.src = ('https:' == document.location.protocol ? 'https://' : 'http://') + 'ZZZZ.userzoom.com/feedback/js/uz_feed_us.js?cuid=7540AB346CCDE41180C90050569444FB';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(uz, s);
})();
//]]></script>

 

 

Add custom variables when triggering a study in a Mobile app

✅ Plan Availability (included): Premium
➕ Plan Availability (when purchased separately): Essentials, Professional, and International

• You can add variables in mobile app intercepts (tags with Start method of Start app or At a Specific Section of the App).
• For more information refer to our SDK documentation for iOS or Android.

 

 

Related content

Want to learn more? Check out these Knowledge Base articles...  Site Intercept advanced cookie configuration Trigger a Site Intercept or Feedback Tab on specific pages	Interested in growing your skills? Check out our University courses... Site intercepts & Feedback tabs Surveys
Need hands-on training? Find a live, virtual class that fits your needs. Enroll in one of our UserZoom certification programs.	Can't find your answer? Reach out to Support or our Professional Services team.