Selecting Custom Variables
To get the most out of UserIQ, we recommend you to pass along some identifying information about your users. This will help you segment your users based on their activity. It will also help us track which users have been presented a Guided Tour or other in-app messages and interactions.
What are custom variables?
Custom Variables are the tracked attributes of users within your web application, which enable detailed user segmentation. This helps you create highly personalized engagements.
How many variables can I have?
Currently we have not set a limit to the number of variables you can pass, however, there are 6 mandatory variables that are required (the character limit for most variables is 255).
Which variables should I push?
You should push all variables and key indicators used to analyze your customers. This can include anything from your customers’ roles, locations, time zones, languages, membership status, etc. You can add an unlimited number of variables as you deem necessary for segmentation.
What are Mandatory variables?
These variables are required to be pushed to UserIQ.
You MUST pass a unique User ID as Custom Variable #1 (i.e.; internal id, numeric, email, etc.).
UserIQ works best if you pass these 6 variables stated above:
#1: user_id (string)
- This variable is required to track individual users accurately
- Please name the KEY as user_id in the variable
- This is the individual user's id (this can be a string of digits, an email, a name etc.)
- It must be unique
- If you pass a user's e-mail address as user_id it is mapped to both user_id and user_email
#2: user_name (string)
- Please name the KEY as user_name
- This is the individual user's name
#3: account_id (string)
- Please name the KEY as account_id
- This is the account identifier that users roll up to
#4: account_name (string)
- Please name the KEY as account_name
- This the account name that users roll up to
#5: signup_date (string)
- Please name the KEY as signup_date
- Please pass data as YYYY-MM-DD
- This is the date the user signed up for or started using your product
#6: user_email (string)
- Providing user_email enables helpful features in UserIQ
- Please name it user_email
What Additional Types can I Pass to UserIQ?
You can pass any other variables that help you to segment your users.
These are examples that your company may currently be using that you would like to send over. You may need to engage your development team to determine what variables you are able to push to UserIQ.
You can also pull data into custom variable fields from salesforce through our SFDC-UserIQ integration. You can have a deeper insight on this integration by having a look at our article on Salesforce Integration here: UserIQ - Salesforce Integration.
Examples of variable types:
User Type Variables
- Admin_level (features seen)
- User_role (job title)
- Customer_value (MRR/ARR)
- Plan_type (Basic/Premium)
- Adoption_level (Products purchased)
CRM/Financial Data Variables
- Plan_status (Active/Inactive/Paid)
- Opportunity_size (in $/Account)
- Territory (Sales trigger for upsell)
- Industry (by Account)
Customer Success Data
- Last_outreach (i.e. QBR or strategy meeting)
- Support_calls (# of – to identify churn risks)
- Support_package (special announcements)
- Trainings_given (to complement efforts)
- Certifications_earned (to reinforce info)
How do I Configure Custom Variables?
To pass custom variables such as user name, account ID, etc., simply replace the ‘red text’ text in the tracking snippet that comes after ‘setCustomVariable’,’#’
To add an additional variable, simply add the following:
Note: Make sure you do NOT delete the quotes. Make sure to remove // to uncomment out code.