Custom Variables

1. When should you use custom variables?

When you want to display your messages to one specific segment of your visitors. Custom variables give you the power to base your audience segmentation on any variable you define.

This feature has been proven useful when there is additional information about your visitors that can be used to group them into different audience segments.

2. Why should I use custom variables?

Custom variables give you the ability to present highly-tuned messages to specific audience segments.

For instance, an ecommerce site can use previous orders or items viewed as custom variables. These custom variables trigger specific messages related to those orders and items. This is an excellent way to encourage repeat business or generate buzz for a new product offering.

3. How do I setup my site for OptiMonk to retrieve my custom variables?

OptiMonk retrieves data on custom variables you define using JavaScript code. You define the custom variables and their value within the JavaScript code and then place that code on your site.

4.What code do I need for OptiMonk to retrieve the data on my custom variables?

The JavaScript code below should be inserted into the source code of your site to define the custom variable:

<script type="text/javascript">
    var OptiMonkOnReady = function () {
        var adapter = OptiMonk.Visitor.createAdapter();
        adapter.attr('variable_name', 'variable_value');

A real-life example could look like this:

<script type="text/javascript">
    var OptiMonkOnReady = function () {
        var adapter = OptiMonk.Visitor.createAdapter();
        adapter.attr('registered', 'yes');
        adapter.attr('hasorder', 'no');

In the example above two custom variables have been defined:

  • "registered" and "hasorder"

with the values:

  • "yes" and "no"

After the JavaScript code has been executed by a visitor to your site, we save those values in the visitor’s browser. The value is stored here until we change it explicitly.

To remove a custom variable, use the following method:

<script type="text/javascript">
    var adapter = OptiMonk.Visitor.createAdapter();

5. Some important details to note when inserting the code

  • The name of the variables cannot include special characters
  • Variables are case sensitives
  • The OptiMonkOnReady function should be defined only once, i.e. - only one time per page.

6. How do I setup my OptiMonk campaigns to use my custom variables?

  1. Login to your OptiMonk account and go to the "Campaign Settings" page for the Campaign you want to use with your custom variables.
  2. Find the option for: "Visitors who have the following custom variables set". Here is where you can setup rules based on your custom variables.

The following 4 parameters should be setup for each rule:

  1. The name of the variable
  2. The type of the variable: text or number.
  3. The method of comparison: equals, doesn’t equal, contains, doesn’t contain, is set, isn’t set, greater than, less than, greater than or equal to, less than or equal to.
  4. Which value it should be compared to


The value of [named] variable, which is a text, equals yes.

Have more questions? Submit a request