Implementing UserIQ
- Determine Primary custom variables
- Install UserIQ Tracking Code
- Verify install
1. Determine Primary custom variables
Custom variables are information (descriptions or metadata) that you pass for Users and Accounts to better identify and provide context in UserIQ. The more information you pass regarding your users and accounts, the better you are able to target engagements and segment data for analysis. There is no limit to the number of variables you pass. If you intend to use an integration like Salesforce, click here for important information.
The primary custom variables are used in your tracking code and are considered real-time information. Additional variables can be passed through an API and/or one of our integrations. See here for more information.
The following 6 custom variables need to appear exactly as they do here in the KEY column, including case and format (underscore). All dates need to follow the ISO format YYYY-MM-DD
Required Variables
| Key | Example |
| user_id | Tstark33 or email |
| account_id | 1547894 |
Recommended Variables
| Key | Example |
| user_name | Tony Stark |
| account_name | Stark Industries |
| signup_date | 2017-12-01 |
| user_email | tony@starkind.com |
Examples of Additional Custom Variable - click here for more information
| Key | Use This To... | Example |
| permission_level | Identify and target users based on their permission levels | L2 Administrator |
| user_type | Identify and target users based on their user type | Standard User |
| is_admin | Segment and target admin users | true |
| mrr | Track your Monthly Recurring Revenue | $2000.00 |
| arr | Track your Annual Recurring Revenue | $24,000.00 |
| product_type | Send segmented engagements to users on different pricing tiers (free, basic, premium, enterprise, etc.) | Premium |
| product_purchased | Send unique messaging based on products purchased (base, salesforce_integration, etc.) | Scheduling |
| role | Identify users based on role (admin, reviewer, approver, etc.) | Approver |
| first_name | Users first name | Tony |
| last_name | Users last name | Stark |
| industry | Example: Healthcare, Real estate, Technology, Automotive | Healthcare |
| renewal_date | Contract renewal date | 2021-12-01 |
2. Install UserIQ Tracking Code
You will receive an email from UserIQ with your Site ID and a sample of the tracking code. This is used to identify your account and must be updated in the tracking code along with your primary custom variables.
Click here for directions on installing the tracking code into your environment.
3. Verify Install
Make sure the tracking code has been installed correctly. We recommend checking the pages of your app and confirm the correct variables are being passed on each page along with access to the admin panel.
Once you have installed the tracking code, log into both UserIQ and your app on the same browser. You should see the admin panel in the lower right corner of each page, which looks like the following:
Click here for details on how to confirm the correct variables are being passed on each page
Comments
0 comments
Article is closed for comments.