Creating and pushing a custom data




Create a new custom data

Creating a custom data enables you to target visitors according to data already available, such as user account information.

Several fields help you set up your custom data.

Structure of the creation pop-in

  1. Select one or several websites and name the new custom data
  2. Define how to get the value of the data
  3. Tell Kameleoon how to use the imported data
  4. Assign a category to this data

Website selection and custom data name

Name your custom data to easily identify it.

Avoid names that are too long and choose relevant names that reflect the characteristics of the custom data.

If several websites are selected, you will need to check that custom data is being pulled from each of these sites.

There is a limit to 150 active custom data, so consider carefully before creating them and don’t double up.

Value retrieval

  • Acquisition Method

In the dropdown menu, choose the custom data’s value retrieval method.

The main tag management tools are available:

  • GTM data layer
  • Tag Commander data layer
  • Tealium

For these tag managers, you need to indicate the name of the variable to get.

If you choose to use a custom JavaScript code to retrieve the value you need, carefully check the code and be careful with the use of scripts.

If the “Kameleoon Activation API” option is selected, this means that your website needs to regularly make calls to the Kameleoon Activation API.

  • Type

When Kameleoon reads the data value, will it be expecting a single value or a table of values?

In the drop-down menu, select the format of the data to be retrieved.

The data can be of type :

  • string (example: “woman dress”)
  • boolean (example: female = “true/false”)
  • number (example: cart amount = “127”)


  • single (example: “127”)
  • list (example: “126, 127, 128”; “shoes, dress, coat”)
  • count list of (example: “shoes: 3, dress: 1, coat: 1”)
  • Scope

In the drop-down menu, select the scope of your custom data.

  • page: For each new page, we reset the data value, for example a cart amount.
  • visit: The value of the data is reset at each new visit by the visitor. For example: geolocation.
  • visitor: The unit of data relates to the visitor and not to the visit. For example: female = true.



Custom data is evaluated each time the page is displayed. In case of “undefined” response, the code is executed again (every 100 ms for the first 3 seconds after the first attempt, then every 3 seconds).


  • Stock the data only on the user’s Local Storage and not on any server

If your custom data is only used for targeting, you do not need to stock the data on the server; in this case, it is recommended to use the LocalData API. This saves space compared to the limit of 150 active custom data. Note however that when you use the LocalData API, the custom data cannot then be used on the results page.

If you choose to stock the data on the server, be careful not to save sensitive data. Also be aware that the value of a custom data is limited to 1000 characters when it is sent to the server.

  • Use this custom data as a unique identifier for cross-device history reconciliation

If you enable this option, a value (the email address, for example) can only be associated with one visitor)This means a visitor can be uniquely recognized. It enables cross-device tracking (ensure that the mapping IDs have a unique value for each visitor, otherwise cross-device tracking is pointless).

Learn more about cross-device history with our FAQ article and our developer documentation.

  • Use this data as input for our machine learning algorithms

To use the machine learning option, you need to activate Audiences.

If Predict is configured: you have to choose whether to feed in this data or not. Do not activate if the custom data is highly targeted.

Only “number”- and “Boolean”-type custom data are accepted.

Do not add a date, time stamp or visitor identifier (email, customer account number, etc.), since those elements only concern a single visitor and therefore don’t allow you to analyze general behavior.

Advanced settings

The “Advanced Settings” option offers to assign categories to your new custom data. You can assign as many categories as you want. Just enter the name of the category and press “Enter”. You can delete a category by clicking on the button next to its name and edit it by clicking on the name itself.

Click on “Next” to validate the custom data’s creation and access the last step of its setup.

Test custom data

Use our testing tool to check if your custom data is correctly set up.

Just enter the URL of the page the custom data has been set up on and click on “Test”. Kameleoon will run a custom data retrieval check on this page.

If the custom data has been associated with several websites, it is necessary to test them one by one.

In case of error, information helps you to identify the source of the problem.

You can also skip this step and go back to the previous page.

Define a custom data as targeting condition

To add a custom data to a new segment, select the data of your choice in the “Custom Data” tab of the conditions column. Only the custom data configured on the website is displayed.

In the dropdown menu, determine the required value of the custom data for a user to be targeted and include / exclude the visitors meeting the custom data condition.

Depending on the type of custom data, the configuration of the targeting condition changes (“is true/is false”, “contains”, “is equal to”…).

Filter/ventilate by custom data on the results page

On the results page of an experiment, it is possible to filter or break down the results according to a custom data associated with the experiment.

This will give you more detailed analyses for reporting purposes.

More about custom data on our developer documentation