Skip to main content
Con el SDK de React de Kameleoon, puede ejecutar experimentos de funcionalidad y activar feature flags en sus aplicaciones web y móviles de front-end. Integrar nuestro SDK en sus aplicaciones web y móviles es sencillo y su huella (memoria y uso de red) es baja. Primeros pasos: Para obtener ayuda para comenzar, consulte la guía del desarrollador Changelog: Encontrará información sobre la última versión del SDK de React en el changelog. Métodos del SDK: Para la documentación de referencia completa del SDK de React, consulte la sección referencia. Requisitos: El SDK de React requiere React 16.8.0+

Guía del desarrollador

Follow this section to integrate the SDK into your application and learn more about using the SDK.

Primeros pasos

This section walks you through installing and configurating the SDK for the first time.

Instalación

The Kameleoon SDK Installation tool is the preferred way to install the SDK. This SDK Installer helps you to install the SDK of your choice, generate a basic code sample, and configure external dependencies if needed. To start the SDK Installation tool, install and run it globally:
O ejecútela directamente con npx:

Crear el cliente Kameleoon

To get started to create an entry point for React SDK by creating Kameleoon Client on the top level of your application. Create an instance of KameleoonClient using the createClient() function, imported from the kameleoon package.

Envolver la aplicación en el Kameleoon Provider

The second step is connecting the previously created Kameleoon Client to KameleoonProvider by passing the configured client to KameleoonProvider:
KameleoonProvider
Use this provider on root level by wrapping your app to gain an access to KameleoonClient. This ensures your app does not flicker due to flag changes at startup time.
Props
KameleoonProviderSSR
Use this provider on root level by wrapping your app to gain an access to KameleoonClient. KameleoonProviderSSR differs from KameleoonProvider in that it creates a KameleoonClient instance inside the context on the first client request. This prevents the risk of creating the client on the server side. It is recommended for use in SSR-based systems, como por ejemplo Next.js with SSR.
Props

Esperar a la inicialización del cliente

KameleoonClient initialization is done asynchronously in order to make sure that Kameleoon API call was successful for that hook useInitialize is used. You can use async/await, Promise.then() or any other method to handle asynchronous client initialization.

Activar un feature flag

Asignar un identificador único a un usuario
To assign a unique ID to a user, you can use the getVisitorCode() method. If a código de visitante doesn’t exist (from the request headers cookie), the method generates a random unique ID or uses a defaultVisitorCode that you would have generated. The ID is then set in a response headers cookie. If you are using Kameleoon in Hybrid mode, calling the getVisitorCode() method ensures that the unique ID (código de visitante) is shared between the application file engine.js (previously named, kameleoon.js) and the SDK.
Retrieving a flag configuration
To implement a feature flag in your code, you must first create the feature flag in your Kameleoon account. To determine the status or variation of a feature flag for a specific user, you should use the getVariation() or isFeatureFlagActive() method to retrieve the configuration based on the featureKey. The getVariation() method handles both simple feature flags with ON/OFF states and more complex flags with multiple variations. The method retrieves the appropriate variation for the user by checking the feature rules, assigning the variation, and returning it based on the featureKey and visitorCode. The isFeatureFlagActive() method can be used if you want to retrieve the configuration of a simple feature flag that has only an ON or OFF state, as opposed to more complex feature flags with multiple variations or targeting options. If your feature flag has associated variables (como por ejemplo specific behaviors tied to each variation) getVariation() also enables you to access the Variation object, which provides details about the assigned variation and its associated experiment. This method checks whether the user is targeted, finds the visitor’s assigned variation, and saves it to storage. When track=true, the SDK will send the exposure event to the specified experiment on the next solicitud de seguimiento, which is automatically triggered based on the SDK’s tracking_interval_millisecond. By default, this interval is set to 1000 milliseconds (1 second). The getVariation() method allows you to control whether tracking is done. If track=false, no exposure events will be sent by the SDK. This is useful if you prefer not to track data through the SDK and instead rely on client-side tracking managed by the Kameleoon engine, for example. Adicionalmente, setting track=false is helpful when using the getVariations() method, where you might only need the variations for all flags without triggering any tracking events. If you want to know more about how tracking works, view this article
Adding data points to target a user or filter / breakdown visits in reports
To target a user, ensure you’ve added relevant data points to their profile before retrieving the feature variation or checking if the flag is active. Use the addData() method to add these data points to the user’s profile. Para recuperar los puntos de datos recogidos en otros dispositivos o para acceder a los datos pasados del usuario (recogidos en el lado del cliente cuando se utiliza Kameleoon en modo híbrido), utilice el método getRemoteVisitorData(). This method asynchronously fetches data from the servers. It is important to call getRemoteVisitorData() before retrieving the variation or checking if the feature flag is active, as this data might be required to assign a user to a given variation. To learn more about available targeting conditions, see the detailed article on the subject. Adicionalmente, the data points you add to the visitor profile will be available when analyzing your experiments, allowing you to filter and break down your results by factors like device and browser. Kameleoon Hybrid mode automatically collects a variety of data points on the client-side, making it easy to break down your results based on these pre-collected data points. See the complete list here. Si necesita rastrear puntos de datos adicionales más allá de lo que se recoge automáticamente, puede utilizar la funcionalidad Custom Data de Kameleoon. Custom Data le permite capturar y analizar información específica relevante para sus experimentos. No olvide llamar al método flush() para enviar los datos recogidos a los servidores de Kameleoon para su análisis.
To ensure your results are accurate, it’s recommended to filter out bots by using the UserAgent data type.
Tracking goal conversions
When a user completes a desired action (como por ejemplo making a purchase), it is recorded as a conversion. To track conversions, use the trackConversion() method and provide the required visitorCode and goalId parameters. La solicitud de seguimiento de la conversión se enviará junto con la siguiente solicitud de seguimiento programada, que el SDK envía a intervalos regulares (definidos por tracking_interval_millisecond). If you prefer to send the request immediately, use the flush() method with the parameter instant=true.
Sending events to analytics solutions
To track conversions and send exposure events to your customer analytics solution, you must first implement Kameleoon in Hybrid mode. Then, use the getEngineTrackingCode() method. The getEngineTrackingCode() method retrieves the unique tracking code required to send exposure events to your analytics solution. Using this method allows you to record events and send them to your desired analytics platform.

Consideraciones para React Native

React Native on android platform doesn’t support Real Time Update feature.
While React SDK works the same way in both React Native and React contexts, it’s important to note that setup steps differ. Due to the lack of browser API in React Native, React SDK has to have different external dependency implementations to work correctly. For that, Kameleoon provides several dedicated npm packages that you can install and set up manually or install using Kameleoon SDK Installation Tool (recommended). The packages include:
  • @kameleoon/react-native-storage - built using react-native-mmkv library
  • @kameleoon/react-native-event-source - built using react-native-event-source-ts library
  • @kameleoon/react-native-visitor-code-manager - built on top of react-native-mmkv library
  • @kameleoon/react-native-platform-analyzer - built using react-native library
  • optional @kameleoon/react-native-secure-prng - built using react-native-get-random-values library
If you don’t want to use the listed packages, you can provide your own implementation following the external dependencies guide. Example React SDK setup for React Native application:

Uso de una clave de bucketing personalizada

By default, Kameleoon uses a unique, anonymous visitor ID (visitorCode) to assign users to feature flag variations. This ID is typically generated and stored on the user’s device (in a browser cookie for client-side and server-side SDKs—in persistent storage for mobile SDKs). Sin embargo, in certain scenarios you may need to ensure all users of the same organization see the same variant of a feature flag. The Custom Bucketing Key option allows you to override this default behavior by providing your own custom identifier for bucketing. This override ensures that Kameleoon’s assignment logic uses your specified key instead of the default visitorCode.

Casos de uso

Using a custom bucketing key is essential for maintaining consistency and accuracy in your feature flag assignments, particularly in these situations:
  • Experimentos a nivel de cuenta u organización: Para productos B2B o escenarios en los que desea asignar a todos los usuarios de la misma organización a la misma variación, puede utilizar un identificador como un accountId. Las claves de bucketing personalizadas son fundamentales para realizar pruebas A/B de funcionalidades que afectan a todo un equipo o empresa.
Al implementar una clave de bucketing personalizada, garantiza una mayor consistencia y precisión en sus experimentos, lo que se traduce en resultados más fiables y una mejor experiencia de usuario.

Detalles técnicos

Cuando configura una clave de bucketing personalizada para un feature flag, proporciona a Kameleoon un identificador específico procedente de los datos de su aplicación:
  • Providing the custom key: You provide your custom identifier to the Kameleoon SDK using the addData() method. In this method, you will pass your chosen custom bucketing key as a CustomData object. Here, newVisitorCode refers to the identifier you wish to use for your bucketing (for example, the new userId or accountId).
For the custom bucketing key to function correctly, it must also be defined and configured for the feature flag during the flag creation or editing process. Without this corresponding configuration, the SDK’s bucketing will not apply your custom key. For detailed instructions on how to set this up in Kameleoon, refer to this article.
  • Bucketing logic: Once a custom bucketing key is provided through the addData() method, all hash calculations for assigning users to variations will use this newVisitorCode (your custom key) instead of the default visitorCode. Using the newVisitorCode means that the bucketing decision is tied to your custom identifier, ensuring consistent assignments across various contexts where that identifier is present.
  • Data tracking and analytics: It’s crucial to note that while the newVisitorCode (your custom key) is used for bucketing decisions, all subsequent data (tracking events and conversions, for example) is sent and associated with the original visitorCode. This separation ensures that your analytics accurately reflect individual user journeys and interactions within your experiment’s broader context, even when bucketing is performed at a higher level (like an account) or across multiple devices/sessions. Your original datos del visitante remains intact for comprehensive reporting.

Requisitos técnicos

To effectively use a custom bucketing key:
  • The key must be a string.
  • Debe ser única para la entidad que desea segmentar (por ejemplo, si utiliza un userId, el ID de cada usuario debe ser único).
  • La clave debe estar disponible para el SDK en el momento exacto en el que se evalúa la decisión del feature flag para ese usuario o solicitud.

Condiciones de segmentación

Los SDKs de Kameleoon admiten una variedad de condiciones de segmentación predefinidas que puede utilizar para segmentar usuarios en sus campañas. Para ver la lista de condiciones admitidas por este SDK, consulte usar el historial de visitas para segmentar usuarios. También puede utilizar sus propios datos externos para segmentar usuarios.

Registro de logs

The SDK generates logs to reflect various internal processes and issues.

Niveles de log

The SDK supports configuring limiting logging by a log level.

Gestión personalizada de los logs

El SDK escribe sus logs en la salida de consola de forma predeterminada. Este comportamiento puede modificarse.
La limitación de los logs por nivel de log se realiza de forma independiente a la lógica de gestión de los logs.

Información del dominio

You provide a domain as the domain in KameleoonClient [configuration], which is used for storing Kameleoon código de visitante in cookies. This is important when working with the getVisitorCode and setLegalConsent methods. The domain you provide is stored in the cookie as the Domain= key.

Configurar el dominio

The domain you provide indicates the URL address can use the cookie. Por ejemplo, if your domain is www.example.com. the cookie is only available from a www.example.com URL. That means that pages with the app.example.com domain can’t use the cookie. To be more flexible around subdomains, you can prefix a domain with .. Por ejemplo, the domain .example.com allows the cookie to function on both app.example.com and login.example.com.
No puede utilizar expresiones regulares, símbolos especiales, protocolo ni números de puerto en domain. Adicionalmente, a specific list of subdomains are not allowed to be used with the prefix ..
A continuación se ofrece una pequeña hoja de referencia para dominios:

Desarrollo en localhost

localhost is always considered a bad domain, making it hard to test the domain when developing on localhost. There are two ways to avoid this issue:
  • Don’t specify the domain field in the SDK client while testing. This prevents localhost issues (the cookie will be set on any domain).
  • Create a local domain for localhost. Por ejemplo:
    • Navigate to /etc/hosts on Linux or to c:\Windows\System32\Drivers\etc\hosts on Windows
    • Open hosts with file super user or administrator rights
    • Add a domain to the localhost port, for example: 127.0.0.1 app.com
    • Now you can run your app locally on app.com:{my_port} and specify .app.com as your domain

Dependencias externas

Las dependencias externas del SDK utilizan el patrón dependency injection para darle la posibilidad de proporcionar sus propias implementaciones para ciertas partes de un SDK.
In the React SDK, all external dependencies have default implementations, which use a native browser API so there’s no need to provide them unless another API is required for specific use cases.
Here’s the list of available external dependencies: Lo siguiente example implements external dependencies. To import an interface from an SDK, create a class that implements it and pass the instantiated class to the SDK.

Almacenamiento

EventSource

VisitorCodeManager

Requester

Generador de números pseudoaleatorios

Pseudo Random Number Generator (PRNG) is a dependency that generates random floating point number between 0 and 1 (similar to Math.random). Default Kameleoon implementation relies on Browser’s crypto or Math.random function if crypto is not available. Those API are very secure and reliable, however in some edge cases (especially in some React Native engines) you might want to provide your own implementation or use a dedicated Kameleoon package for React Native - @kameleoon/react-native-secure-prng

Gestión de errores

Almost every React SDK callback which is returned by hooks may throw an error at some point, these errors are not just caveats but rather deliberately predefined KameleoonErrors that extend native JavaScript Error class providing useful messages and special type field with a type KameleoonException. KameleoonException is an enum containing all possible error types. To know exactly what type of KameleoonException the callbacks may throw, you can check Throws section of the hooks description on this page or just hover over the callback in your IDE to see jsdocs description. Overall handling the errors considered a good practice to make your application more stable and avoid technical issues.

Experimentación entre dispositivos

To support visitors who access an app from multiple devices, Kameleoon allows the synchronization of previously collected datos del visitante across each of the visitor’s devices and reconciliation of their visit history across devices through cross-device experimentation. Case studies and detailed information on how Kameleoon handles data across devices are available in the article on cross-device experimentation.

Sincronización de datos personalizados entre dispositivos

Aunque se utiliza la sincronización con mapeo personalizado para alinear los datos del visitante entre dispositivos, no siempre es necesaria. A continuación se presentan dos escenarios en los que no se requiere la sincronización con mapeo personalizado: Same user ID across devices If the same user ID is used consistently across all devices, synchronization is handled automatically without a custom mapping sync. It is enough to call the getRemoteVisitorData() method when you want to sync the data collected between multiple devices. Multi-server instances with consistent IDs In complex setups involving multiple servers (for example, distributed server instances), where the same user ID is available across servers, synchronization between servers (with getRemoteVisitorData()) is sufficient without additional custom mapping sync. Customers who need additional data can refer to the getRemoteVisitorData() method description for further guidance. In the below code, it is assumed that the same unique identifier (in this case, the visitorCode, which can also be referred to as userId) is used consistently between the two devices for accurate data retrieval.
Si desea sincronizar los datos recogidos en tiempo real, debe elegir el ámbito Visitor para sus datos personalizados.
Device One
Device Two

Uso de datos personalizados para la fusión de sesiones

Cross-device experimentation allows you to combine a visitor’s history across each of their devices (history reconciliation). One of the powerful features that history reconciliation provides is the ability to merge different visitors sessions into one. To reconcile visit history, you can use CustomData to provide a unique identifier for the visitor.Follow the activating cross-device history reconciliation guide to set up your datos personalizados on the Kameleoon platformWhen your datos personalizados is set up, you can use it in your code to merge a visitor’s session. Sessions with the same identifier will always see the same experiment variation and will be displayed as a single visitor in the Visitor view of your experiment’s result pages.La configuración del SDK garantiza que las sesiones asociadas siempre vean la misma variación del experimento.Before using other methods make sure to let SDK know that the visitor is a unique identifier by adding UniqueIdentifier data to a visitor
As the datos personalizados you use as the identifier must be set to Visitor scope, you need to use cross-device datos personalizados synchronization to retrieve the identifier with the getRemoteVisitorData method on each device.
Here’s an example of how to use datos personalizados for session merging. En este ejemplo, we have an application with a login page. Since we don’t know the user ID at the moment of login, we use an anonymous visitor identifier generated by the getVisitorCode method. After the user logs in, we can associate the anonymous visitor with the user ID and use it as a unique identifier for the visitor.
Login Page
Application Page

Utilidades

SDK has a set of utility methods that can be used to simplify the development process. All the methods are represented as static members of KameleoonUtils class.

simulateSuccessRequest

Method simulateSuccessRequest is used to simulate a successful request to the Kameleoon server. It can be useful for custom Requester implementations when developer needs to simulate a successful request, for example disabling tracking.
Argumentos
Data type SimulateRequestDataType is defined de la siguiente manera:
  • RequestType.Tracking - null
  • RequestType.ClientConfiguration - ClientConfigurationDataType
  • RequestType.RemoteData - JSONType
Return value

getCookieValue

Method getCookieValue is used to parse a common cookie string (key_1=value_1; key_2=value_2; ...) and get the value of a specific cookie key. It’s useful when working with a custom implementation of VisitorCodeManager.
Argumentos
Return value

Referencia

This is the full reference documentation for the React SDK.

Inicialización

This section provides the methods you use to create and initialize the Kameleoon Client in your application.

initialize()

An asynchronous initialize function, collected with useInitialize hook, that’s used for KameleoonClient initialization by fetching Kameleoon SDK related data from server or by retrieving data from local source if data is up-to-date or update interval has not been reached.
  • If the SDK configuration could not be retrieved but there is an older configuration available in SDK storage, the SDK uses the older configuration as a fallback and the initialize does not throw an error.
  • SDK supports an offline mode.
In offline mode if solicitudes de seguimiento from any of lo siguiente methods fail due to internet connectivity issues, the SDK automatically resends the request as soon as it detects that the internet connection has been re-established:
Return value
Exceptions thrown

isInitialized()

The isInitialized function, collected with the useInitialize hook, is a small utility method that checks if the SDK initialization has completed. Por ejemplo, this can be useful when dealing with a deeply nested component tree, because it allows you to quickly check the SDK readiness without having to manage a global state, or pass the initialization result using component props.
Return value
A boolean value. Returns true if SDK was successfully initialized, otherwise returns false.

createClient()

To get started, you need to create an entry point for React SDK by creating a Kameleoon Client at the top level of your application using the createClient() function imported from kameleoon package. An instance of KameleoonClient is created using createClient() function.
Argumentos
An object of type SDKParameters containing:
Parámetros de configuración
Option 1 (Recommended): Use JSON.stringify()
Option 2: Raw JSON string (escape special characters)
Return value
Make sure not to use several client instances in one application as it is not fully supported yet and may overwrite the local storage configuration and cause unintended behavior (bugs).

Feature flags y variaciones

This section provides the methods you use to retrieve and manage the feature flags and variations assigned to the visitor.

getVariation()

  • 📨 Sends Tracking Data to Kameleoon (depending on the track parameter)
Retrieves the Variation assigned to a given visitor for a specific feature flag. This method takes featureKey as a mandatory argument and track as an optional argument. The track argument is optional and defaults to true. It returns the assigned Variation for the visitor. If the visitor is not associated with any feature flag rules, the method returns the default Variation for the given feature flag. Ensure that proper error handling is implemented in your code to manage potential exceptions.
The default variation refers to the variation assigned to a visitor when they do not match any predefined delivery rules for a feature flag. In other words, it is the fallback variation applied to all users who are not targeted by specific rules. It’s represented as the variation in the “Then, for everyone else…” section in a management interface.
Argumentos
An object of type GetVariationParamsType with lo siguiente properties:
Return value
Exceptions thrown

getVariations()

  • 📨 Sends Tracking Data to Kameleoon (depending on the track parameter)
  • 🎯 Events: EventType.Evaluation
Method is obtained using useFeatureFlag hook.
Retrieves a map of Variation objects assigned to a given visitor across all feature flags. This method iterates over all available feature flags and returns the assigned Variation for each flag associated with the specified visitor. It takes visitorCode as a mandatory argument, while onlyActive and track are optional.
  • If onlyActive is set to true, the method getVariations() will return feature flags variations provided the user is not bucketed with the off variation.
  • The track parameter controls whether or not the method will track the variation assignments. By default, it is set to true. If set to false, the tracking will be disabled.
The returned map consists of feature flag keys as keys and their corresponding Variation as values. If no variation is assigned for a feature flag, the method returns the default Variation for that flag. Proper error handling should be implemented to manage potential exceptions.
The default variation refers to the variation assigned to a visitor when they do not match any predefined delivery rules for a feature flag. In other words, it is the fallback variation applied to all users who are not targeted by specific rules. It’s represented as the variation in the “Then, for everyone else…” section in a management interface.
Argumentos
An object of type GetVariationsParamsType with lo siguiente properties:
Return value
Exceptions thrown

isFeatureFlagActive()

  • 📨 Sends Tracking Data to Kameleoon (depending on the track parameter)
  • 🎯 Events: EventType.Evaluation
The method isFeatureFlagActive(), used with the useFeatureFlag hook, determines whether a visitor identified by visitorCode has the specified featureKey active. This method checks the targeting conditions, identifies the variation for the visitor, and saves this information to storage. Adicionalmente, the hook sends a solicitud de seguimiento. There is also an overload for this method that includes a track parameter, allowing you to disable the tracking of the feature evaluation.
Visitor must be targeted to has feature flag active
Kameleoon uses tracking to count sessions and visitors when you call certain methods, como por ejemplo isFeatureFlagActive(), getVariation() or getVariations().Use the default true value for the track parameter when you expose visitors to a variation and need to count them. Set the track parameter to false only if you call these methods before you expose visitors.Por ejemplo, if you call getVariations() to retrieve all variations before you expose visitors, set the track parameter to false. This setting prevents Kameleoon from prematurely counting a session. You can then trigger tracking later when you explicitly expose the visitor.Kameleoon sends tracking data every second by default. You can configure this interval up to five seconds using the tracking interval configuration option. Kameleoon groups tracking events into a single session as long as the interval between events is less than 30 minutes. If more than 30 minutes elapse between tracking events, Kameleoon counts the events as separate sessions. A visit appears in your reports 30 minutes after the last recorded event in the session.
The isFeatureFlagActive() method evaluates the served variant, not the master flag state. If you exclude rules, the method uses the Then, for everyone else serve default state. If you select Off for this default state, the method always returns false even when the master feature flag is On.
Argumentos
There are two overloads available for this method:
  1. Two parameters overload:
This overload is deprecated and will be removed in the next major version. Please use the new overload with an object parameter.
  1. Object parameter overload of type IsFeatureFlagActiveParamsType:
Return value
Exceptions thrown

setForcedVariation()

The method allows you to programmatically assign a specific Variation to a user, bypassing the standard evaluation process. This is especially valuable for controlled experiments where the usual evaluation logic is not required or must be skipped. It can also be helpful in scenarios like debugging or custom testing. When a forced variation is set, it overrides Kameleoon’s real-time evaluation logic. Processes like segmentation, targeting conditions, and algorithmic calculations are skipped. To preserve segmentation and targeting conditions during an experiment, set forceTargeting=false instead.
Simulated variations always take precedence in the execution order. If a simulated variation calculation is triggered, it will be fully processed and completed first.
A forced variation is treated the same as an evaluated variation. It is tracked in analytics and stored in the user context like any standard evaluated variation, ensuring consistency in reporting. The method may throw exceptions under certain conditions (e.g., invalid parameters, user context, or internal issues). Proper exception handling is essential to ensure that your application remains stable and resilient.
It’s important to distinguish forced variations from simulated variations:
  • Forced variations: Are specific to an individual experiment.
  • Simulated variations: Affect the overall feature flag result.
Argumentos
An object of type SetForcedVariationParametersType with lo siguiente properties:
Exceptions thrown
In most cases, only the basic error, KameleoonException, needs to be handled, as demonstrated in the example. Sin embargo, if different types of errors require a response, handle each one separately based on specific requirements. Adicionalmente, for enhanced reliability, general language errors can be handled by including Error.

evaluateAudiences()

  • 📨 Sends Tracking Data to Kameleoon
This method evaluates visitors against all available Audiences Explorer segments and tracks those who match. evaluateAudiences() should be called after all relevant datos del visitante has been set or updated, and just before getting a feature variation or checking a feature flag. This approach ensures that the visitor is evaluated against the most current data available, allowing for accurate audience assignment based on all criteria. After calling this method, you can perform a detailed analysis of segment performance in Audiences Explorer.
Argumentos
Exceptions thrown
In most cases, only the basic error, KameleoonException, needs to be handled, as demonstrated in the example. Sin embargo, if different types of errors require a response, handle each one separately based on specific requirements. Adicionalmente, for enhanced reliability, general language errors can be handled by including Error.

getDataFile()

To evaluate all feature flags, use getVariations(). This method is more efficient than calling DataFile and iterating through flags with getVariation().
Returns the current SDK configuration as a DataFile object.
Return value

Datos del visitante

This section provides the methods you use to manage datos del visitante.

getVisitorCode()

getVisitorCode method collected from useVisitorCode hook obtains a código de visitante from the browser cookie. If the código de visitante doesn’t exist yet, the function generates a random código de visitante (or uses the defaultVisitorCode value if you provided one) and sets the new código de visitante in a cookie.
The getVisitorCode() method allows you to set simulated variations for a visitor. When cookies (from a request or document) contain the key kameleoonSimulationFFData, the standard evaluation process is bypassed. Instead, the method directly returns a Variation based on the provided data.You can apply simulations in two ways:
  • Automatically (recommended): If using Kameleoon Web Experimentation or the SDK in Hybrid mode, the cookie is created automatically when simulating a variant’s display using the Simulation Panel.
  • Manually: Set the kameleoonSimulationFFData cookie manually.
It’s important to distinguish simulated variations from forced variations:
  • Simulated variations: Affect the overall feature flag result.
  • Forced variations: Are specific to an individual experiment.
⚙️ Manual setupPlease ensure the kameleoonSimulationFFData cookie follows this format:
  • kameleoonSimulationFFData={"featureKey":{"expId":10,"varId":20}}: Simulates the variation with varId of experiment expId for the given featureKey.
  • kameleoonSimulationFFData={"featureKey":{"expId":0}}: Simulates the default variation (defined in the Then, for everyone else in Production, serve section) for the given featureKey.
⚠️ To ensure proper functionality, the cookie value must be encoded as a URI component using a method como por ejemplo encodeURIComponent.
Argumentos
If you don’t provide a defaultVisitorCode and there is no código de visitante stored in a cookie, the código de visitante will be randomly generated.
Return value
Exceptions thrown

addData()

The addData function, used with the useData hook, collects targeting data to store for other hooks to determine if the current visitor is targeted.
  • The addData() function does not return any value and does not interact with Kameleoon back-end servers on its own. Instead, all the declared data is saved for future transmission via the flush method .This approach helps reduce the number of server calls made, as the data is typically grouped into a single server call triggered by the execution of flush.
The trackConversion method also sends out any previously associated data, just like the flush. The same holds true for getFeatureFlagVariationKey and getFeatureVariable methods if an experimentation rule is triggered.
  • userAgent data will not be stored in storage like other data, and it will be sent with every solicitud de seguimiento for bot filtration.
  • Check the list of supported conditions to know what data types can be used for targeting
Each visitor can only have one instance of associated data for most data types. Sin embargo, CustomData is an exception. Visitors can have one instance of associated CustomData per customDataIndex.
Argumentos
  • kameleoonData is variadic argument it can be passed as one or several arguments (see the example)
  • The index or ID of the datos personalizados can be found in your Kameleoon account. It is important to note that this index starts at 0, which means that the first datos personalizados you create for a given site will be assigned 0 as its ID, not 1.
Exceptions thrown
See the Data types reference for more details of how to manage different data types.

flush()

flush() takes the Kameleoon data associated with the visitor and schedules the data to be sent with the next solicitud de seguimiento. The time of the next solicitud de seguimiento is defined by SDK Configuration trackingInterval parameter. Visitor data can be added using addData and getRemoteVisitorData methods.If you don’t specify a visitorCode, the SDK flushes all of its stored data to the remote Kameleoon servers. If any previously failed solicitudes de seguimiento were stored locally during offline mode, the SDK attempts to send the stored requests before executing the latest request.
If you need to send solicitudes de seguimiento immediately, use flushInstant() — the asynchronous version of flush that returns Promise<void>. You can await it when you need delivery guarantees (for example, before page navigation/unload), or call it without await as a fire-and-forget request:
  • await flushInstant(visitorCode) sends solicitudes de seguimiento immediately for a specific visitor and waits for completion
  • await flushInstant() sends solicitudes de seguimiento immediately for all visitors and waits for completion
Argumentos
Or an object with the type FlushParamsType, containing:
Exceptions thrown

getRemoteData()

Asynchronous method getRemoteData, collected with the useData hook, returns a data stored for specified site code on a remote Kameleoon server. Por ejemplo, you can use this function to retrieve user preferences, historical data, or any other data relevant to your application’s logic. By storing this data on our highly scalable servers using our [Data API], you can efficiently manage massive amounts of data and retrieve it for each of your visitors or users.
Argumentos
Return value
Exceptions thrown

getRemoteVisitorData()

getRemoteVisitorData() is an asynchronous method for retrieving Kameleoon Visits Data for the visitorCode from the Kameleoon Data API. The method adds the data to storage for other methods to use when making targeting decisions.Data obtained using this method plays an important role when you want to:
  • use data collected from other devices.
  • access a user’s history, como por ejemplo previously visited pages during past visits.
  • use data that is only accessible on the client-side, like datalayer variables and goals that only convert on the front-end.
Read this article for a better understanding of possible use cases.
By default, getRemoteVisitorData() automatically retrieves the latest stored datos personalizados with scope=Visitor and attaches them to the visitor without the need to call the method addData(). It is particularly useful for synchronizing datos personalizados between multiple devices.
Argumentos
An object with the type RemoteVisitorDataParamsType containing:
Return value
Exceptions thrown
Using parameters in getRemoteVisitorData()
The getRemoteVisitorData() method offers flexibility by allowing you to define various parameters when retrieving data on visitors. Whether you’re targeting based on goals, experiments, or variations, the same approach applies across all data types.Por ejemplo, let’s say you want to retrieve data on visitors who completed a goal “Order transaction”. You can specify parameters within the getRemoteVisitorData() method to refine your targeting. For instance, if you want to target only users who converted on the goal in their last five visits, you can set the previousVisitAmount parameter to 5 and conversions to true.The flexibility shown in this example is not limited to goal data. You can use parameters within the getRemoteVisitorData() method to retrieve data on a variety of visitor behaviors.
Here is the list of available VisitorDataFiltersType filters:

getVisitorWarehouseData()

Asynchronous method getVisitorWarehouseAudience collected with useData hook retrieves all audience data associated with the visitor in your data warehouse using the specified visitorCode and warehouseKey. The warehouseKey is typically your internal user ID. The customDataIndex parameter corresponds to the Kameleoon datos personalizados that Kameleoon uses to target your visitors. Refer to the warehouse targeting documentation for additional details.
Argumentos
Parameters object consisting of:
Return value
Exceptions thrown

setLegalConsent()

Method setLegalConsent, collected with useVisitorCode hook, specifies whether the visitor has given legal consent to use personal data. Setting the legalConsent parameter to false limits the types of data that you can include in solicitudes de seguimiento. This helps you adhere to legal and regulatory requirements while responsibly managing datos del visitante. You can find more information on personal data in the consent management policy.
  • Consent information is in sync between the Kameleoon Engine (application file engine.js) and the React SDK. This synchronization means that once consent is set on either the Engine or the SDK, it’s automatically set for both. This feature eliminates the need for manual consent handling and ensures that SDKs operate in compliance with user preferences.
If you use Kameleoon in Hybrid mode, we recommend reading the consent section in our Hybrid experimentation article
  • When handling legal consent, it’s important to use getVisitorCode method. Adicionalmente, getVisitorCode does not accept domain as an argument. Instead, pass it to the createClient function.
Argumentos
Exceptions thrown
Consent revocation behavior
When you call setLegalConsent() with consent=false, the SDK does not delete the kameleoonVisitorCode cookie. Instead, it stops extending the cookie’s expiration date, allowing the cookie to persist until it naturally expires. If your compliance requirements demand the immediate removal of the cookie file upon opt-out, you must delete it manually using your framework’s native cookie management methods. The SDK will not remove the file automatically.

Objetivos y analítica de terceros

This section provides the methods you use to track when a visitor action achieve one of you goals (a conversion).

trackConversion()

  • 📨 Sends Tracking Data to Kameleoon
The trackConversion() function, used with the useData hook creates and adds Conversion data to the visitor with specified parameters and executes flush().Use this method to track a conversion for a specific goal and user. This method requires visitorCode and goalId. In addition, this method also accepts an optional revenue, negative and metadata arguments. The visitorCode is usually identical to the one that was used when triggering the experiment.The trackConversion() method doesn’t return any value. This method is non-blocking as the server call is made asynchronously.
Argumentos
Parameters object consisting of:
metadata values are accessible through raw data exports and the results page.If the metadata parameter is provided, Kameleoon will use these specified values for the current conversion instead of what was previously collected using the addData() method. If the parameter is omitted, Kameleoon will use the last tracked values for those CustomData prior to the conversion and within the same visit.Kameleoon will only consider the metadata values that are explicitly passed as parameters to the trackConversion() method.In the example below, Kameleoon will associate the conversion only with the datos personalizados value explicitly provided as a parameter (here: index 5 with the value ‘Amex Credit Card’).
Exceptions thrown

getEngineTrackingCode()

Kameleoon integrates with several analytics solutions, including Mixpanel, Google Analytics 4, and Segment. To track server-side experiments correctly, call the getEngineTrackingCode() method after the visitor triggers an experiment. The SDK returns JavaScript queue commands for the experiments that the visitor triggered during the previous five seconds. When you insert this code into the page, Engine.js processes the commands and sends the exposure events through the active analytics integration. Refer to hybrid experimentation for more information on implementing this method.
  • To use this feature, implement both the React SDK and Kameleoon Engine.js. Because Engine.js is used only for tracking in this flow, you can install the asynchronous tag before the closing </body> tag.
  • You can insert the returned tracking code directly into an HTML <script> tag.
En este ejemplo, 123456 and 234567 are experiment IDs, and 7890 and 8901 are variation IDs. In your implementation, the SDK generates these values in the returned tracking code.
Argumentos
Return value
Exceptions thrown

Eventos

This section provides the methods you use to handle events.

onEvent()

Method onEvent, collected with the useInitialize hook, fires a callback when a specific event is triggered. The callback function has access to the data associated with the event. The SDK methods in this documentation note which event types they can trigger, if any.
You can only assign one callback to each EventType.
Events
Events are defined in the EventType enum. Depending on the event type, the eventData parameter will have a different type.
Argumentos
Exceptions thrown

Sending exposure events to external tools
Kameleoon offers built-in integrations with various analytics and CDP solutions, como por ejemplo Mixpanel, Google Analytics 4, Segment…. To ensure that you can track and analyze your server-side experiments, Kameleoon provides a method getEngineTrackingCode() that returns the JavasScript code to be inserted in your page to automatically send the exposure events to the analytics solution you are using. The SDK builds a tracking code for your active analytics solution based on the experiments that the visitor has triggered in the last 5 seconds. Para más información sobre hybrid experimentation, please refer to this documentation.
To benefit from this feature, you will need to implement both the React SDK and our Kameleoon JavaScript tag. We recommend you implement the [Kameleoon asynchronous tag], which you can install before your closing <body> tag in your HTML page, as it will be only used for tracking purposes.

Tipos de datos

Kameleoon Data types are helper classes used for storing data in storage in predefined forms. During the flush execution, the SDK collects all the data and sends it along with the solicitud de seguimiento. Data available in the SDK is not available for targeting and reporting in the Kameleoon app until you add the data. Por ejemplo, by using the addData() method. See use visit history to target users for more information.
If you are using hybrid mode, you can call getRemoteVisitorData() to automatically fill all data that Kameleoon has collected previously.

Browser

Since React SDK 10.11.0, Browser is automatically detected based on the User-Agent string. Sin embargo, you can still manually override it if needed.
Browser contains browser information.
Each visitor can only have one Browser. Adding a second Browser overwrites the first one.

UniqueIdentifier

UniqueIdentifier data is used as marker for unique visitor identification. If you add UniqueIdentifier for a visitor, visitorCode is used as the unique visitor identifier, which is useful for Cross-device experimentation. Associating a UniqueIdentifier with a visitor notify SDK that the visitor is linked to another visitor. The UniqueIdentifier can also be useful in other edge-case scenarios, como por ejemplo when you can’t access the anonymous visitorCode that was originally assigned to the visitor, but you do have access to an internal ID that is connected to the anonymous visitor using session merging capabilities.
Each visitor can only have one UniqueIdentifier. Adding another UniqueIdentifier overwrites the first one.

Conversion

The Conversion data set stored here can be used to filter experiment and personalization reports by any goal associated with it.
  • Each visitor can have multiple Conversion objects.
  • You can find the goalId in the Kameleoon app.
ConversionParametersType conversionParameters - an object with conversion parameters described below
Cookie contains information about the cookie stored on the visitor’s device.
  • Generally, the React SDK will attempt to use a localStorage cookie for the conditions. If not possible, SDK can use Cookie data as an alternative.
  • Each visitor can only have one Cookie. Adding a second Cookie overwrites the first one.
Methods
Cookie data has a static utility method fromString that you can use to create a cookie instantly by parsing a string that contains valid cookie data. The method accepts string as parameter and returns an initialized Cookie instance.

GeolocationData

GeolocationData contains the visitor’s geolocation details
Each visitor can only have one GeolocationData. Adding a second GeolocationData overwrites the first one.
An object parameter with the type GeolocationInfoType containing lo siguiente fields:

CustomData

To retain datos personalizados for future visits, the SDK transmits CustomData with a Visitor scope during the next solicitud de seguimiento. You can configure the scope in the data settings on the datos personalizados dashboard. CustomData allows you to associate any type of data with each visitor easily. This data can then be used as a targeting condition in segments or as a filter or breakdown in experiment reports. Para más información sobre datos personalizados, please refer to this article.
  • Each visitor is allowed only one CustomData for each unique index. Adding another CustomData with the same index will replace the existing one.
  • The datos personalizados ‘index’ can be found in the Custom Data dashboard under the “INDEX” column.
  • To prevent the SDK from sending data with the selected index to Kameleoon servers for privacy reasons, enable the option: Use this data only locally for targeting purposes when creating datos personalizados.
  • Adding a CustomData instance created with a name when the SDK instance is not initialized or the name is not registered, will result in the data being ignored.

Device

Since React SDK 10.11.0, Device is automatically detected based on the User-Agent string. Sin embargo, you can still manually override it if needed.React Native: Support for this feature is currently experimental and may require adjustments to work correctly. In React Native, the Device is automatically detected based on the DPI from react-native.Dimensions.
Device contains information about your device.
Each visitor can only have one Device. Adding a second Device overwrites the first one.

OperatingSystem

Since React SDK 10.11.0, OperatingSystem is automatically detected based on the User-Agent string. Sin embargo, you can still manually override it if needed.React Native: Support for this feature is currently experimental and may require adjustments to work correctly. In React Native, the OperatingSystem is automatically detected based on the react-native.Platform.
OperatingSystem contains the visitor’s operating system information.
Each visitor can only have one OperatingSystem. Adding a second OperatingSystem overwrites the previous one.

PageView

Since React SDK 10.11.0, PageView is automatically detected based on the window.location?.href and document.title. Sin embargo, you can still manually override it if needed.React Native: Support for this feature is currently experimental and may require adjustments to work correctly.
PageView contains information about your web page.
Each visitor can have one PageView per unique URL. Adding a PageView with the same URL as an existing one will notify SDK that the visitor revisited page
PageViewParametersType pageViewParameters - an object with page view parameters described below

UserAgent

Store information on the user-agent of the visitor. Server-side experiments are more vulnerable to bot traffic than client-side experiments. To address this, Kameleoon uses the IAB/ABC International Spiders and Bots List to identify known bots and spiders. Kameleoon also uses the UserAgent field to filter out bots and other unwanted traffic that could otherwise skew your conversion metrics. For more details, see the help article on bot filtering. If you use internal bots, we suggest that you pass the value curl/8.0 of the userAgent to exclude them from our analytics.
A visitor can only have one UserAgent. Adding a second UserAgent overwrites the first one.
Server-side experiments are more vulnerable to bot traffic than client-side experiments. To address this, Kameleoon uses the IAB/ABC International Spiders and Bots List to identify known bots and spiders. We recommend that you pass the user agent to be filtered by Kameleoon when running server-side experiments for each visitor browsing your website, to avoid counting bots in your analytics.If you use internal bots, we suggest that you pass the value curl/8.0 of the userAgent to exclude them from our analytics.

ApplicationVersion

ApplicationVersion represents the semantic version number of your application.
A visitor can have only one ApplicationVersion. Adding a second instance will overwrite the first one.

Tipos devueltos

DataFile

The DataFile contains the SDK configuration details. It can be extended with additional information if required by clients. If you need more details, please contact your Customer Success Manager.

FeatureFlag

The FeatureFlag represents a set of properties that define a feature flag itself — for example, its Variations, Rules, environment status, and other related details. It can be extended with additional information if required by clients. If you need more details, please contact your Customer Success Manager.

Rule

The Rule represents a set of properties that define a rule itself — for example, its Variations. It can be extended with additional information if required by clients. If you need more details, please contact your Customer Success Manager.

Variation

Variation contains information about the assigned variation to the visitor (or the default variation, if no specific assignment exists).
  • Ensure that your code handles the case where id or experimentId may be null, indicating a default variation.
  • The variables map might be empty if no variables are associated with the variation.

Variable

Variable contains information about a variable associated with the assigned variation.

Métodos obsoletos

These methods are deprecated and will be removed in the next major update.

getFeatureFlagVariationKey()

  • 📨 Sends Tracking Data to Kameleoon
  • 🎯 Events: EventType.Evaluation
Use the getVariation method.
The method getFeatureFlagVariationKey(), which is used with the useFeatureFlag hook, retrieves the variation key for a visitor identified by their visitorCode. This process includes checking the targeting criteria, identifying the appropriate variation assigned to the visitor, storing this information, and sending a solicitud de seguimiento.
If a user has never been associated with a feature flag, the SDK will randomly return a variation key according to the rules of that feature flag. If the user is already linked to the feature flag, the SDK will identify the previously assigned variation key. If the user does not meet any of the specified rules, the SDK will return the default value defined in Kameleoon’s feature flag delivery rules. It’s important to note that the default value may not always be a variation key; it could also be a boolean value or another data type, depending on how the feature flag is configured.
Argumentos
Return value
Exceptions thrown

getVisitorFeatureFlags()

  • 🚫 Doesn’t send Tracking Data to Kameleoon
  • 🎯 Events: EventType.Evaluation (for each feature flag)
Use the getVariations method.
The getVisitorFeatureFlags method, utilized with the useFeatureFlag hook, returns a list of active feature flags that target the visitor associated with the visitorCode (the visitor must have one of the allocated variations).
This method only collects the feature flags that are currently active for the visitor. As a result, it does not include any feature flags for which the visitor is assigned to the “off” variation (default or control). If you need to retrieve all of the visitor’s feature flags, use getFeatureFlags instead.Por ejemplo:
For cases where you need all of the visitor’s feature flags, use getFeatureFlags instead:
Argumentos
Return value
Exceptions thrown

getActiveFeatureFlags()

  • 🚫 Doesn’t send Tracking Data to Kameleoon
  • 🎯 Events: EventType.Evaluation (for each feature flag)
Use the getVariations method.
The getActiveFeatureFlags method, collected with the useFeatureFlag hook, returns a Map, where key is feature key and value is detailed information about the visitor’s variation and it’s variables
This method only collects the visitor’s active feature flags. This means the result excludes all the feature flags for which the visitor is assigned to the off (default or control) variation. When you need all of the visitor’s feature flags to iterate over, use getFeatureFlags instead.See the getVisitorFeatureFlags CAUTION section method for more details.
Argumentos
Return value
Exceptions thrown

getFeatureFlagVariable()

  • 📨 Sends Tracking Data to Kameleoon
  • 🎯 Events: EventType.Evaluation
Use the getVariation method.
The getFeatureFlagVariable method, collected with useFeatureFlag hook, returns a variable for the visitor under visitorCode in the found feature flag, this includes targeting check, finding the according variation exposed to the visitor and saving it to storage along with sending solicitud de seguimiento.
Argumentos
Parameters object of type GetFeatureFlagVariableParamsType containing lo siguiente fields:
Return value
Exceptions thrown

getFeatureFlagVariables()

  • 📨 Sends Tracking Data to Kameleoon
  • 🎯 Events: EventType.Evaluation (for each feature flag)
Use the getVariations method.
The getFeatureFlagVariables method, collected with the useFeatureFlag, hook returns a list of variables for the visitor under visitorCode in the found feature flag, this includes targeting check, finding the according variation exposed to the visitor and saving it to storage along with sending solicitud de seguimiento.
Argumentos
Return value
Exceptions thrown

onConfigurationUpdate()

Use the onEvent method with EventType.ConfigurationUpdate instead.
Method onConfigurationUpdate collected with useInitialize hook fires a callback on client configuration update.
This hook only works for server sent events of real time update
Argumentos
Exceptions thrown

getFeatureFlags()

🚫 Doesn’t send Tracking Data to Kameleoon The getFeatureFlags method collected with the useFeatureFlag hook returns a list of feature flags stored in the client configuration.
Return value
Exceptions thrown