# Customer custom parameters

# What is a customer custom parameter?

In addition to the general data that FunnelFlex.AI automatically collects for each page, you can manually pass additional page-specific data.

For example, if a user is authenticated in your system and you know their gender and age, you can specify these additional data as customer parameters.

# How can customer parameters help?

Firstly, you can use the specified parameters in display conditions.

Secondly, these data will be used in model training.

# How long is the user parameter stored?

The user parameter is stored in the local storage (opens new window) of the current user and remains there until deleted or overwritten.

Once you set a user parameter, it will be available on all pages of the website in the current and subsequent sessions of that user.

# What are the limitations on the number of user parameters?

A user parameter value can have a maximum of 512 characters. If a longer value is passed, it will be truncated to the first 512 characters.

You can specify as many user parameters as needed, but keep in mind that local storage has a limited size in many browsers (usually around 5 to 10 MB, but it's safer to assume 5 MB).

FunnelFlex.AI (like most other applications) uses local storage for many functions, so even less space is available for storing user parameters.

To store data in local storage browsers use UTF-16 encoding (opens new window), meaning each character occupies 2 bytes.

Thus, even if you specify 1000 user parameters of maximum size (512 characters each), you will only occupy 20% of the available local storage capacity.

Therefore, in practice, you don't need to worry about limitations on the number of user parameters.

# Methods for working with customer custom parameters

# Setting a parameter

To set a user parameter within the connection script, use:

<script>
    /** INIT_SCRIPT  */

    impact('init','your-unique-project-code');
    impact('setUserParam', 'key', value) // "value" can be a string or number
    impact('start');
</script>

For setting a user parameter outside of the connection script, use:

impact('setUserParam', 'key', value)

The set user parameter starts being considered in data transmission only after it is set.

If some data has already been transmitted to the server and the user parameter is set afterward, the parameter will not be included in the already transmitted data.

Therefore, we recommend specifying all visit parameters within the connection script before calling impact('start');`

# Delet a parameter

To delete a user parameter, use the function:

impact('deleteUserParam', 'key')

# Get parameter

To get a single user parameter, use the function:

window.SustainImpact.getUserParam("key") // This synchronous function works only when window.SustainImpact.ready == true

# Get all parameters

To get all user parameters, use the function:

window.SustainImpact.getUserParams() // This synchronous function works only when window.SustainImpact.ready == true

← Personalization event Page custom parameters →