Référence API - Kameleoon Documentation

Kameleoon.API.Core

Ce module contient des fonctions pour implémenter des variations A/B testing front-end sans clignotement. Utilisez ces méthodes dans l’ordre prescrit pour des résultats optimaux. Le module inclut également des méthodes d’initialisation du moteur, y compris celles pour les lois sur la confidentialité et la collecte du consentement légal. Avant d’appeler l’objet JavaScript de l’Activation API, vérifiez que le moteur Kameleoon a été chargé. Utilisez la Command Queue de Kameleoon pour l’exécution différée de commandes lorsque vous envoyez des données de suivi, déclenchez des expériences ou mettez à jour des attributs visiteur. Si le moteur est chargé, les commandes et fonctions transmises s’exécutent immédiatement ; sinon, elles entrent dans une file d’attente pour exécution ultérieure. Pour plus d’informations, consultez l’ Command queue documentation.

enableLegalConsent

var agreedButton = Kameleoon.API.Utils.querySelectorAll("#agreed")[0];

Kameleoon.API.Utils.addEventListener(agreedButton, "mousedown", function (event) {
  Kameleoon.API.Core.enableLegalConsent();
});

Appelez la enableLegalConsent() method après avoir obtenu le consentement légal du visiteur pour activer Kameleoon. Cette méthode active le mode de fonctionnement normal de Kameleoon. Pour plus d’informations, consultez l’ Consent management article.

Arguments

Name	Type	Description
module	String	Nom du module to enable: “PRODUCT_RECOMMENDATION”, “AB_TESTING”, “PERSONALIZATION”, or “BOTH”. Par exemple, `PRODUCT_RECOMMENDATION` executes the entry point exclusively with product recommendation capabilities. `AB_TESTING` enables A/B testing and product recommendation (unless the custom option to differentiate consent is active). `OTH` enables all capabilities. Si omis, the method active legal consent for all modules (`BOTH`) by default.

A custom option is also available that allows separate management of Product Recommendation consent. Lorsque this option is active, explicitly call enableLegalConsent("PRODUCT_RECOMMENDATION") to activate the module. Contact the Customer Success Manager to enable this feature.

disableLegalConsent

var disableButton = Kameleoon.API.Utils.querySelectorAll("#disable")[0];

Kameleoon.API.Utils.addEventListener(disableButton, "mousedown", function (event) {
  Kameleoon.API.Core.disableLegalConsent();
});

Appelez la disableLegalConsent() method lorsque a visitor declines the use of Kameleoon. Cette méthode disables normal operation mode. Pour plus d’informations, consultez l’ Consent management article.

Arguments

Name	Type	Description
module	String	Nom du module to disable: “AB_TESTING”, “PERSONALIZATION”, or “BOTH”. Si omis, the method disables legal consent for all modules (`BOTH`).

A custom option is also available that allows separate management of Product Recommendation consent. Lorsque this option is active, explicitly call disableLegalConsent("PRODUCT_RECOMMENDATION") to disable the module. Contact the Customer Success Manager to enable this feature.

enableSinglePageSupport

if (location.href.indexOf("mySPAWebsitePart") != -1) {
  Kameleoon.API.Core.enableSinglePageSupport();
}

The enableSinglePageSupport() method reloads le moteur Kameleoon lorsque the active URL changes, regardless of browser page loads. Utilisez cette méthode for Single Page Applications (SPAs) with multiple URLs and a single initial load. Kameleoon treats each URL change as a new page, enabling URL targeting and accurate tracking of metrics like page views.

Kameleoon will also automatically remove all elements that have been added on la page that use HTML IDs that begin with “kameleoonElement” or “kameleoonStyleSheet” lorsque the SPA reloads.

enableDynamicRefresh

if (location.href.indexOf("cart") != -1) {
    Kameleoon.API.Core.enableDynamicRefresh();
}

The enableDynamicRefresh() method detects element changes and reapplies Graphic Editor modifications. Cette méthode supports SPAs that dynamically modify the DOM without URL changes or page reloads, preventing dynamic updates from removing experiments. Consultez enableSinglePageSupport() for other SPA types.

getConfiguration

var configuration = Kameleoon.API.Core.getConfiguration();

if (configuration.siteCode == "abcde12345") {
  document.cookie = "MyMainSite=true;";
} else if (configuration.siteCode == "12345abcdef") {
  document.cookie = "MySubSite=true;";
}

The getConfiguration() method retourne un reference to the Configuration object, which contains global constant values for the site’s Kameleoon configuration.

Valeur de retour

Name	Type	Description
configuration	Object	Configuration object.

load

var href = location.href;

var intervalId = Kameleoon.API.Utils.setInterval(function () {
  if (location.href != href) {
    Kameleoon.API.Core.load();
  }
}, 2000);

The load() method initializes le moteur Kameleoon. While initialization typically occurs automatically during application file loading, you might need to make manual calls. The example demonstrates how to implement reloads after each URL change, similar to enableSinglePageSupport().

Kameleoon will also automatically remove all elements that have been added on la page that use HTML IDs that begin with “kameleoonElement” or “kameleoonStyleSheet” lorsque the SPA reloads.

processRedirect

var experiment = Kameleoon.API.Experiments.getByName("RedirectExperiment");

if (experiment.associatedVariation.id == 123456) {
  Kameleoon.API.Core.processRedirect("https://www.mywebsite.com?variation=A");
}

The processRedirect() method redirects the browser to another URL, typically for split A/B experiments. Utilisez cette méthode au lieu de window.location.href = redirectionURL; to ensure accurate background tracking.

Si le redirection URL is on a domain other than the base URL and the Kameleoon installation omits unified session data, le moteur adds a kameleoonRedirect-{experimentID} parameter to the target URL to ensure accurate tracking.

Arguments

Name	Type	Description
redirectionURL	String	URL for redirection. This field is mandatory.

runWhenConditionTrue

Kameleoon.API.Core.runWhenConditionTrue(function () {
  return typeof jQuery != "undefined";
}, function () {
  jQuery("#bloc-2345").text("Mon nouveau texte");
}, 200);

The runWhenConditionTrue() method executes the callback function lorsque the conditionFunction retourne true. La méthode uses a polling mechanism, which might cause flickering. Use runWhenElementPresent() instead for improved performance. Consultez the runWhenElementPresent() description for details.

Arguments

Name	Type	Description
conditionFunction	Function	JavaScript function returning true or false. This field is mandatory.
callback	Function	JavaScript function executing lorsque the conditionFunction retourne true. This field is mandatory.
pollingInterval	Number	The engine executes the conditionFunction periodically at this interval. Lorsque `runWhenElementPresent()` is unavailable, a lower pollingInterval reduces flickering but increases CPU usage. Si omis, the method defaults to 200 milliseconds.

runWhenElementPresent

// With mutation observers management.
Kameleoon.API.Core.runWhenElementPresent("#bloc-2345", function (elements) {
 elements[0].innerText = "My new Text";
});

// With multiple CSS selectors. Executes if any one of the elements is present.
Kameleoon.API.Core.runWhenElementPresent("#bloc-567, .cta-button, #bloc-789", function (elements) {
 elements[0].innerText = "More new text";
});

// Without mutation observers management, Kameleoon polls every 200ms to check if the element is on the page.
Kameleoon.API.Core.runWhenElementPresent("#MyPopup.showed", function (elements) {
 Kameleoon.API.Events.trigger("popup displayed");
}, 200);

// With mutation observers management and Single Page App support, Kameleoon applies modifications whenever new elements are added to the DOM or when there is a dynamic refresh of the Single Page App that removes previous modifications.
Kameleoon.API.Core.runWhenElementPresent(".product-button", function (elements) {
 elements.forEach(element => {
  element.innerText = "Add To Cart";
 });
}, null, true);

The runWhenElementPresent() method executes the callback function lorsque a specific element appears in the DOM. Cette méthode uses mutation observers to power antiflickering technology. Identify the key elements for une variation and call runWhenElementPresent() with the element as the first argument and the implementation code as the callback. This ensures that modifications execute as soon as the element appears, before the browser initiates a display refresh cycle. To act on multiple elements, call runWhenElementPresent() separately for each element rather than targeting only the expected final element. A single call may result in flickering if a refresh cycle occurs between the appearance of different elements.

Providing this value disables Mutation Observers and Anti-Flickering, reverting to legacy polling. Use this argument only in specific cases, tel que complex selector queries with high CPU impact.

Arguments

Name	Type	Description
selector	String	CSS selector of the element. To specify multiple CSS selectors, provide a single comma-separated string. The callback executes lorsque one or more elements exist. This field is mandatory.
callback	Function	JavaScript function to execute lorsque the element appears in the DOM. This field is mandatory.
pollingInterval	Number	Providing this value disables Mutation Observers and reverts le moteur to legacy polling, which may cause flickering. This field is optional.
isDynamicElement	Boolean	Lorsque active, Kameleoon tracks the selector if not immediately found at page load and executes the callback as elements appear. The callback déclenche again for each new element matching the selector. This setting supports dynamic menus, infinite scrolling, and pop-ups. This field is optional.

runWhenShadowRootElementPresent

const wrapper = document.querySelector(".shadow-wrapper");
const shadow = wrapper.attachShadow({ mode: "open" });
const span = document.createElement("span");
span.classList.add("selector-inside-wrapper");
span.textContent = "I'm in the shadow DOM";
shadow.appendChild(span);

Kameleoon.API.Core.runWhenShadowRootElementPresent('.shadow-wrapper', '.selector-inside-wrapper', (elements) => {
    elements[0].innerText = "New text" 
});

The runWhenShadowRootElementPresent() method executes the callback function lorsque a specific element appears in a shadow DOM set to mode: open.

Arguments

Name	Type	Description
parentSelector	String	CSS selector for the parent element. This field is mandatory.
shadowRootElementSelector	String	CSS selector inside the shadow DOM. This field is mandatory.
callback	Function	JavaScript function to execute lorsque the element appears in the shadow DOM. This field is mandatory.
isDynamicElement	Boolean	Lorsque active, Kameleoon tracks the selector if not immediately found and executes the callback as elements appear. The callback déclenche again for each new element matching the selector. This setting supports dynamic menus, infinite scrolling, and pop-ups.

Kameleoon.API.Goals

This module manages goal triggering and conversion data, including purchase confirmations and revenue registration.

cancelConversion

var buttons = Kameleoon.API.Utils.querySelectorAll(".btnRemoveFromCart");

buttons.forEach(function (button) {
  Kameleoon.API.Utils.addEventListener(button, "mousedown", function (event) {
    Kameleoon.API.Goals.cancelConversion(event.target.id);
  });
});

The cancelConversion() method cancels a conversion that you déclenché during the current visit. Cette méthode cannot cancel conversions from previous visits.

Arguments

Name	Type	Description
goalNameOrID	String or Number	Name or ID of l’objectif as defined in the Kameleoon App. This field is mandatory.

processConversion

Before implementing the processConversion, review the Custom Code for Custom Goal feature, which simplifies customization by removing the requirement for un objectif ID.

//Conversion for "Add to cart" goal (goal id 123456)
Kameleoon.API.Core.runWhenElementPresent("#buyButton", ([buyButton]) => {
  Kameleoon.API.Utils.addEventListener(buyButton, "click", () => {
    Kameleoon.API.Goals.processConversion(123456); //Add to cart
  });
});

//Conversion for "Add to cart" goal (goal id 123456) with optional revenue argument
Kameleoon.API.Core.runWhenElementPresent("#buyButton", ([buyButton]) => {
  Kameleoon.API.Utils.addEventListener(buyButton, "click", () => {
    Kameleoon.API.Goals.processConversion(123456, 19.99); //Add to cart
  });
});

The processConversion() method déclenche a conversion. Metadata must be configured in the Kameleoon App before setting them with processConversion().

Si vous initiate conversions from a Tag Management System, tel que Google Tag Manager, use the Kameleoon Command Queue to delay execution until le moteur loads. The engine processes queued commands in order after initialization. Example:

window.kameleoonQueue = window.kameleoonQueue || [];
kameleoonQueue.push(['Kameleoon.API.Goals.processConversion', 'GOAL_ID']);

Arguments

Name	Type	Description
goalNameOrID	String or Number	Name or ID of l’objectif as defined in the Kameleoon App. Goal names must be unique. This field is mandatory.
revenue	Number	Transaction amount. Providing this value enables Kameleoon to track purchase metrics, tel que revenue and average cart amount. This field is optional.
metadata	Object	Sets specific values for custom data defined as goal metadata in the Kameleoon App. Must be defined beforehand in the Kameleoon App. The object keys are the custom data indexes (numeric values found in the `INDEX` column of the Custom data dashboard). This field is optional.

Metadata values are accessible through raw data exports and the results page.Si vous provide the metadata parameter, Kameleoon uses those values pour le conversion au lieu de the values you previously collected through setCustomData(). Si vous omit the parameter, Kameleoon uses the last tracked customData values before the conversion in the same visit.Kameleoon only considers the metadata values you pass directly to the processConversion() method; it ignores previously set custom data. In the following example, the conversion associates only with the provided metadata (for example, index 5 with ‘Amex Credit Card’).

Kameleoon.API.Data.setCustomData(5, 'Credit Card');
Kameleoon.API.Data.setCustomData(9, 'Express Delivery');

Kameleoon.API.Goals.processConversion("GoalIDorName", revenue, {
    5: ["Amex Credit Card", "PayPal"], // PaymentMode Custom Data
    4: 1234567, // OrderID CustomData
    3: "1q2w3e4r" // PayPalID CustomData 
})

triggerGoal (Custom Code for Custom Goal)

To trigger custom goals, inject custom code by creating a new goal and adding the code to the Trigger my goal panel.

The triggerGoal() function déclenche l’objectif de la code panel without requiring un objectif ID.

//No params
triggerGoal();
//With revenue
triggerGoal(49.99);
//With revenue and metadata
triggerGoal(49.99, {5: "Gold"});

Arguments

Name	Type	Description
revenue	Number	Transaction amount. Providing this value enables Kameleoon to track purchase metrics, tel que revenue and average cart amount. This field is optional.
metadata	Object	Sets specific values for custom data defined as goal metadata in the Kameleoon App. The object keys are the custom data indexes (numeric values found in the `INDEX` column of the Custom data dashboard). This field is optional.

Metadata values are accessible through raw data exports and the results page.Si vous provide the metadata parameter, Kameleoon uses those values pour le conversion au lieu de the values you previously collected through setCustomData(). Si vous omit the parameter, Kameleoon uses the last tracked customData values before the conversion in the same visit.Kameleoon only considers the metadata values you pass directly to the triggerGoal() method; it ignores previously set custom data. In the following example, the conversion associates only with the provided metadata (for example, index 5 with ‘Amex Credit Card’).

Kameleoon.API.Data.setCustomData(5, 'Credit Card');
Kameleoon.API.Data.setCustomData(9, 'Express Delivery');

triggerGoal( revenue, {
    5: ["Amex Credit Card", "PayPal"], // PaymentMode Custom Data
    4: 1234567 // OrderID CustomData,
    3: "1q2w3e4r" // PayPalID CustomData 
})

Kameleoon.API.Data

This module provides methods to set custom data for tracking customer or visit characteristics. It also includes data management methods to retrieve and write data in Kameleoon’s unified LocalStorage.

readLocalData

var userId = Kameleoon.API.Data.readLocalData("myUserId");

if (userId) {
  Kameleoon.API.Data.retrieveDataFromRemoteSource(userId, function (data) {
    console.log(data.returningVisitor);
  });
}

The readLocalData() method reads local data you previously stored through writeLocalData(). The engine retrieves this data from unified Local Storage, which bypasses standard storage limitations.

Arguments

Name	Type	Description
key	String	Key of the data to retrieve. This field is mandatory.

Valeur de retour

Name	Type	Description
value	String	Value of the data.

performRemoteSynchronization

Kameleoon.API.Data.performRemoteSynchronization("customDataName", "customDataValue", false);

The performRemoteSynchronization() method déclenche a Server Synchronization Call (SSC) to the Data API. This call retrieves visit history stored on Kameleoon backend servers for le visiteur actuel and writes it to LocalStorage. This ensures that the data is accessible through the Activation API and available for targeting. Cette méthode typically runs automatically for cross-device reconciliation or Safari ITP; it does not require manual invocation.

Arguments

Name	Type	Description
key	String	Key of the custom data serving as the mapping identifier (e.g., account ID or email). Si omis, the method uses the default identifier configured for cross-device reconciliation in the Kameleoon App.
value	String	Current visitor identifier value used for the Data API call. Si omis, the method uses the current value of the custom data provided in the first argument.
currentVisitOnly	Boolean	Lorsque active, the SSC requests data only pour le visit. Use this optimization to refresh custom data values acquired via the Data API or Server-to-Server integration. Si omis, the method defaults to false.

resetCustomData

Kameleoon.API.Data.resetCustomData("MyCustomDataName");

The resetCustomData() method resets a custom data value.

Arguments

Name	Type	Description
name	String	Nom du custom data as defined in the Kameleoon App. This field is mandatory.

retrieveDataFromRemoteSource

if (location.href.indexOf("loginPage") != -1) {
  Kameleoon.API.Core.runWhenConditionTrue(function () {
    return typeof dataLayer != null;
  }, function () {
    dataLayer.forEach(function (map) {
      if (map.userId) {
        Kameleoon.API.Data.retrieveDataFromRemoteSource(userId, function (data) {
          Kameleoon.API.Data.setCustomData("known_user", data.knownUser);
        });
      }
    });
  }, 200);
}

The retrieveDataFromRemoteSource() method retrieves data stored on a remote Kameleoon server with the specified key. Cette méthode supports retrieving data previously stored through the Data API. Use this for quick storage and retrieval of large data volumes for visitors. This asynchronous mechanism requires a callback function lorsque the server call completes.

Arguments

Name	Type	Description
key	String	The lookup key. This field is mandatory.
callback	Function	Function called lorsque data has been retrieved. It is called with a *data argument that is a JS Object. This field is mandatory.

setCustomData

// Single Type Custom Data
Kameleoon.API.Data.setCustomData("mySingleCustomDataName", "myNewValue"); --> "myNewValue"

// List Type Custom Data
Kameleoon.API.Data.setCustomData("myListCustomDataName", "myFirstValue"); --> ["myFirstValue"]
Kameleoon.API.Data.setCustomData("myListCustomDataName", "mySecondValue"); --> ["myFirstValue", "mySecondValue"]
Kameleoon.API.Data.setCustomData("myListCustomDataName", ["myThirdValue", "myFourthValue"]); --> ["myFirstValue", "mySecondValue", "myThirdValue", "myFourthValue"]
Kameleoon.API.Data.setCustomData("myListCustomDataName", ["myThirdValue", "myFourthValue"], true); --> ["myThirdValue", "myFourthValue"]

// Count List Type Custom Data
Kameleoon.API.Data.setCustomData("myCountListCustomDataName", "myFirstValue"); --> {value: 'myFirstValue', count: 1}
Kameleoon.API.Data.setCustomData("myCountListCustomDataName", "myFirstValue"); --> {value: 'myFirstValue', count: 2}
Kameleoon.API.Data.setCustomData("myCountListCustomDataName", "mySecondValue"); --> --> {value: 'myFirstValue', count: 2}, {value: 'mySecondValue', count: 1}

The setCustomData() method sets a custom data value.

Arguments

Name	Type	Description
CustomDataNameOrIndex	String or Number	Name or Index of the custom data as defined in the Kameleoon App. (the index appears in the ‘INDEX’ column of the Custom Data dashboard). This field is mandatory.
value	String, Number, Boolean, Array	Value of the custom data. The argument provided should match the type declared for this custom data in the Kameleoon app. This field is mandatory. Please be aware that `setCustomData()` accepts String, Number, and Boolean lorsque the `Type` is set to `Single`. Si le `Type` is set to `List` or `Count List`, it will accept an array of String or Number.
overwrite	Boolean	Facultatif boolean. Lorsque `true`, the new value overwrites existing custom data. Lorsque `false` or omitted: Lists/Count Lists append values (all values appear in reports); Single types overwrite (only the latest value appears); Page-scoped Custom Data (all types) append values.

writeLocalData

Kameleoon.API.Data.writeLocalData("myData", "myDataValue", true);

The writeLocalData() method records local data in le visiteur’s browser for later retrieval through readLocalData(). The engine stores this as unified session data in Local Storage, bypassing standard storage limitations. Data becomes available immediately for retrieval in the same tab through RAM caching, while the physical write occurs asynchronously.

Arguments

Name	Type	Description
key	String	Key (name) of the data to write. This field is mandatory.
value	String	Value of the data to write. This field is mandatory.
persistent	Boolean	Toggle data persistence. Non-persistent data expires after 1 hour, while persistent data remains for 30 days. Si omis, the method defaults to false.

Kameleoon.API.Events

This module déclenche custom events for experiment and personalization targeting. Review the Activation API events documentation for standard DOM events.

trigger

Kameleoon.API.Events.trigger("myTriggerEventName");

The trigger() method déclenche a custom event for targeting segments.

Arguments

Name	Type	Description
eventName	String	Name of l’événement to trigger. This field is mandatory.

Kameleoon.API.Tracking

This module integrates Kameleoon results with third-party tracking and analytics platforms, tel que Adobe Analytics (Omniture).

processOmniture

function s_doPlugins(s) {
  /* Kameleoon Integration */
  window.kameleoonQueue = window.kameleoonQueue || [];
  kameleoonQueue.push(['Tracking.processOmniture', s]);
  window.kameleoonOmnitureCallSent = true;

  // Add your other doPlugins code below
}

s.doPlugins = s_doPlugins;

Kameleoon provides a native integration with Adobe Analytics (Omniture). Follow the example to modify the file containing the s_doPlugins() code. Complete these steps within the function:

Add a call to Kameleoon.API.Tracking.processOmniture().
Set the window.kameleoonOmnitureCallSent global variable to true to track initial call transmission. Although you can set this variable elsewhere, you should set it within s_doPlugins().

The integration minimizes the number of Adobe Analytics hits to help you manage costs. Kameleoon sends an additional hit only if une expérience or personalization déclenche after the main tracking call. This results from asynchronous loading (in which Kameleoon loads after the analytics code) or “late” triggers, tel que those that occur after page load, for example button clicks. If Kameleoon loads first and identifies active experiments at page load, the global tracking call includes all additional data.

Arguments

Name	Type	Description
omnitureObject	Object	Reference to your Omniture object. Usually, the global “s” variable (window.s) represents the Omniture object. It is also passed comme argument (named “s” as well) to the `s_doPlugins()` method. This field is mandatory.

Kameleoon.API.Products

This module provides access to the product catalog. Use it to register product views or purchases, add products to a cart, retrieve recommendations, or obtain product statistics, tel que hourly or daily view and purchase counts.

This module est disponible lorsque subscribed to the Product Recommendation module or Product Targeting add-on.

obtainRecommendedProducts

Kameleoon.API.Products.obtainRecommendedProducts(
  "1a2b3c4d",
  {
    item: 123500,
    exclude: [3, 14, 159, 26535],
    category: 146,
    search_query: "To be or not to be",
    limit: 15,
    brands: ["Alas", "poor", "Yorick", 'kameleooner'],
    categories: [1, 146, 123500]
  },
  function (response) {
    // the functionality of rendering a block of product recommendations
  },
  function (error) {
    // when something went wrong
  }
);

The obtainRecommendedProducts() method retrieves recommended products computed by the specified algorithm through an asynchronous server call.

Cette méthode requires correct product tracking, tel que trackProductView() or trackCategoryView(), to return meaningful results.

Arguments

Name	Type	Description
code	String	Unique code of the recommendation block.
params	Object	Parameters to control the data returned by the recommendation platform.
successCallback	Function	Callback function receiving the API response object. This field is mandatory.
errorCallback	Function	Callback function executing if an error occurs. This field is optional.

Parameters to control the data returned by the recommendation platform

Name	Type	Description
item	String	ID du current product. Obligatoire for “Similar” and “They also bought this product” algorithms.
exclude	Array	Comma-separated list of product identifiers for exclusion.
extended	Number	Lorsque “1”, the method retourne full product details. Si omis, it retourne only product IDs.
category	Number	Obligatoire for algorithms on category pages. Limits recommendations to the specified category.
categories	Array	This field is optional. If used, it retourne recommended products only de la specified categories (a comma-separated list of category IDs).
brands	Array	This field is optional. If used, it retourne recommended products only from specified brands (a comma-separated list of brands).
locations	Array	This field is optional. If used, it retourne recommended products available in the listed locations (a comma-separated list of location IDs).
limit	Number	This field is optional. Maximum number of recommended products.
exclude_brands	Number	This field is optional. A comma-separated list of brands that must be excluded de la recommendation.

API response

The callback function receives the API response object with the following values.

Name	Type	Description
html	String	The block HTML code. Customize the HTML template in the Kameleoon personal account.
title	String	The block title. Corresponds to the value of the “Action” element in the block rules.
products	Array	A list of product IDs.
id	Number	Unique block identifier. Corresponds to the block ID in the list of blocks in the Kameleoon personal account

trackAddToCart

var buyButton = Kameleoon.API.Utils.querySelectorAll("#buyButton")[0];
Kameleoon.API.Utils.addEventListener(buyButton, "mousedown", function () {
  Kameleoon.API.Products.trackAddToCart("myProductId", 19.99, 1, {
    stock: true, 
    recommended_code: 'some-unique-code' //see the arguments table for more information
    recommended_by: 'dynamic'//see the arguments table for more information
  });
});

The trackAddToCart() method déclenche lorsque a visitor adds a product to the shopping cart.

Arguments

Name	Type	Description
productID	String	Unique product identifier. This field is mandatory.
unitPrice	Number	Price for a single unit of the product referenced by productID. This field is optional; if not specified, the default price of the product de la imported product feed will be used.
amount	Number	Total quantity of the product after the cart update. Use non-incremental values. Par exemple, if the cart contains two items with the same `productID` and you add another, specify 3. Si vous remove two items from a cart containing 20, specify 18.
parameters	Object	Parameters for the recommendation platform. This field is optional.

Parameters for the recommendation platform

Name	Type	Description
recommended_by	String	For SPAs or pop-ups, set this value to “dynamic”. This field is mandatory in specific scenarios.
recommended_code	String	For SPAs or pop-ups, provide the unique widget code found in the “data-recommender-code” attribute in your account.
stock	Boolean	Product availability. This value overrides data from product feeds or catalog imports. This field is optional.

trackAddToWishList

Kameleoon.API.Products.trackAddToWishList("myProductId"); // to add to wish list

Kameleoon.API.Products.trackAddToWishList("myProductId", -1); // to remove from wish list

The trackAddToWishList() method executes lorsque a visitor adds or removes a product de la wish list or favorites.

Name	Type	Description
productId	String	Unique identifier of the product added to the wishlist. This field is mandatory.
quantity	Number	Quantity to update. Use negative values (e.g., -1) to indicate removal. Si omis, the method defaults to 1.

trackCategoryView

if (location.href.indexOf("productPage") != -1) {
  Kameleoon.API.Core.runWhenConditionTrue(function () {
    return typeof dataLayer != null;
  }, function () {
    dataLayer.forEach(function (map) {
      if (map.categoryID) {
        Kameleoon.API.Products.trackCategoryView(5);
      }
    });
  }, 200);
}

The trackCategoryView() method executes for each category page view during a session.

Arguments

Name	Type	Description
categoryID	String	Unique category identifier. This field is mandatory.

trackProductView

Kameleoon.API.Products.trackProductView("myProductID", {
    "name": "productName",
    "categories": [{
        "id": "13",
        "name": "productCategory",
        "parent": null,
        "url": "website.com/category/2"
    }],
    "imageURL": "https://www.mywebsite/productImage.jpg",
    "price": 19.99,
   "oldPrice": 23.99,
    "accessories": ['productID1', 'productID2'],
    "available": true,
    "availableQuantity": 15,
    "brand": "productBrand",
    "groupId": "groupID1",
    "sku": "productSKU",
    "description": "This is a short description",
    "rating": 4,
    "model": "phone 14 128GB",
    "leftovers": "one",
    "tags": ["shirt", "red"],
    "typePrefix": "mobile phone",
    "seasonality": [1, 2, 3, 10, 11, 12],
    "priceMargin": 100,
    "isChild": false,
    "isNew": false,
    "isFashion": true,
    "auto": {
        "vds": ["BP8AN5", "HH5820"],
        "compatibility": [ 
            {
                "brand": "BMW"
            }, 
            { 
                "brand": "Mini", "model": "Cooper S" 
            } 
        ]
    },
    "fashion":  {
        "gender": "f",
        "type": "shoe",
        "sizes": ["37", "42"],
        "feature": "adult",
        "colors": [ 
            { 
                "color": "red" 
            }, 
            { 
                "color": "green", "picture": "https://example.com/items/395532-green.jpg" 
            }
        ]
    },
    "params": [
        {
            "name": "connectivity",
            "value": ["bluetooth", "wi-fi"]
        },
        {
            "name": "lengths",
            "value": ["4", "6", "8"],
            "unit": "cm"
        }
    ]
});

The trackProductView() method executes for each product view during a session. Cette méthode allows Kameleoon to build an automated product catalog without an XML feed integration, which simplifies the setup of product recommendation projects.

Arguments

Name	Type	Description
productID	String	Product identifier. This can be any unique identifier for this particular product. This field is mandatory.
productData	Object	Product object. This field is mandatory for importing product feeds via the Product Recommendation add-on.

trackSearchQuery

Kameleoon.API.Products.trackSearchQuery("Example search request");

The trackSearchQuery() method records user search queries.

Arguments

Name	Type	Description
search_query	String	The search query value. This field is mandatory.

trackTransaction

Kameleoon.API.Products.trackTransaction(
 [
  {
   "productID": "myProductID1",
   "quantity": 4
  },
  {
   "productID": "myProductID4564",
   "quantity": 1
  }
 ],
 {
  "order": "N318",
  "order_price": 29999
 }
);

The trackTransaction() method executes lorsque a transaction or purchase occurs.

Arguments

Name	Type	Description
products	Array	Liste des objects containing the `productID` and `quantity` for each product in the transaction. This field is mandatory.
params	Object	Additional parameters for the recommendation platform. This field is optional.

Additional parameters for trackTransaction

Name	Type	Description
order	string	Store order number. Si vous omit this, le moteur uses an internal numbering system, which prevents order status synchronization. Consultez the parameter descriptions below.
order_price	Number	Final order cost, including discounts, bonuses, and additional services. Si vous omit this, le moteur calculates the cost de la product database without discounts or services.
email	string	Customer email.
phone	string	Customer phone number.
promocode	string	Transaction promo code.
order_cash	number	Cash payment amount.
order_bonuses	number	Bonus payment amount.
order_delivery	number	Delivery fee.
order_discount	number	Order discount amount.
delivery_type	string	Delivery method.
payment_type	string	Payment type (e.g., “cash”, “card”, “wire”).
tax_free	boolean	Tax-free status.

obtainInstantSearchProducts

Kameleoon.API.Products.obtainInstantSearchProducts(
 {
  search_query: "To be or not to be"
 },
 function (response) {
  // the functionality to render a block from instant search
 },
 function (error) {
  // to handle when something goes wrong
 }
);

The obtainInstantSearchProducts() method retrieves personalized instant search results from Kameleoon Search through an asynchronous server call.

Arguments

Name	Type	Description
search_query	String	User-provided search query. This field is mandatory.
successCallback	Function	Callback function receiving the API response object. This field is mandatory.
errorCallback	Function	Callback function executing if an error occurs. This field is optional.

API response

The callback function receives the API response object with the following values.

Name	Type	Description
search_query	String	Search query
categories	Array	Array with information about categories. Each object has the following properties: id – category id (string) name – category name (string) url – category url (string) count – count of products in category (number)
filters	Array	Array with information about filters. Each object has the following properties: filter – filter object. Has the following properties: count – total count of products whith this parameters (number) values – array of values (object). Has the following properties: value – value label. (string) count – cont of products whith this parameter (number)
html	String	HTML-code of the block with products. The template is customized in the Kameleoon personal account.
price_range	Object	Min and max price of products. Has the following properties: min – min price (number) max – max price (number)
products	Array	Array with information about products. Each object has the following properties: description – product description (string) url – absolute product URL (string) url_handle – relative product URL (string) picture – product’s picture URL in the Kameleoon storage (string) name – product name (string) price – product price (number / int) price_full – product price (number / float) price_formatted – product price with currency (string) price_full_formatted – product price with currency (string) image_url - absolute product’s picture URL in the Kameleoon storage (string) image_url_handle - relative product’s picture URL in the Kameleoon storage (string) image_url_resized - product image resizes url (array) currency – product currency (string, corresponds to the currency of the personal account in Kameleoon, or a custom value specified in the shop settings in the personal account) id – product ID (string) old_price – product old price (number / int, default - 0) old_price_full – product old price (number / float) old_price_formatted – product old price with currency (string) old_price_full_formatted – product old price with currency (string) Additional properties. Si un parameter “extended” is passed in the request categories – product categories (array). Has the following properties: id – category id (string) name – category name (string) parent_id – parent category id (string) url - category url category_ids - product categories ids (array).
search_query_redirects	array	Array with information about redirects. Each object has the following properties: query – search query (string) redirect_link – Url for redirect (string) deep_link – Url for mobile apps (string)
products_tota	Number	Total number of products

obtainFullSearchProducts

Kameleoon.API.Products.obtainFullSearchProducts(
 {
  search_query: "To be or not to be",
  limit: 15,
  brands: ["Alas", "poor", "Yorick"],
  categories: [1, 146, 100500],
  filters: { key: ["value"], key: ["value"] },
  sort_by: "price",
  order: "asc"
 },
 function (response) {
  // the functionality to render a block from full search
 },
 function (error) {
  // when something went wrong
 }
);

Utilisez le obtainFullSearchProducts() method to retrieve full search results de la Kameleoon Search solution with filtering options.

Arguments

Name	Type	Description
search_query	Object	User-provided search query and optional filter parameters. Review the filtering parameters in the next section. This field is mandatory.
successCallback	Function	Callback function receiving the API response object. This field is mandatory.
errorCallback	Function	Callback function executing if an error occurs. This field is optional.

Parameters to filter results

Name	Type	Description
search_query	String	Search query. This field is mandatory.
limit	Number	Limit of results. This field is optional.
offset	Number	Offset of results. This field is optional.
category_limit	Number	How many categories for sidebar filter to return. This field is optional.
categories	Array	Comma separated list of categories to filter. This field is optional.
extended	Number	Set to `true` for full search results.
sort_by	String	Sort by parameter: `popular`, `price`, `discount`, `sales_rate`, `date`. This field is optional.
order	String	Sort direction: asc or desc (default). This field is optional.
locations	Array	Comma separated list of locations IDs. This field is optional.
brands	Array	Comma separated list of brands to filter. This field is optional.
filters	String	Facultatif escaped JSON string with filter parameters. Par exemple: `{"bluetooth":["yes"],"offers":["15% cashback"],"weight":["1.6"]}`. This field is optional.
price_min	Number	Min price. This field is optional.
price_max	Number	Max price. This field is optional.
colors false	Array	Comma separated list of colors. This field is optional.
fashion_sizes	Array	Comma separated list of sizes. This field is optional.
exclude	Array	Comma separated list of products IDs to exclude from search results. This field is optional.
email	String	It’s only for S2S integration, lorsque service doesn’t have user’s session. Mobile SDK doesn’t use it. This field is optional.
no_clarification	Boolean	Disables clarified search. Defaults to false. Do not use this parameter unless instructed by Kameleoon support.
merchants	Array	Comma separated list of merchants. This field is optional.
filters_search_by	String	Available options for filter: `name`, `quantity`, `popularity`. This field is optional.

API response

The callback function receives the API response object with the following values.

Name	Type	Description
brands	Array	Array with information about brands. Each object has the following properties: name – brand name (string) picture – brand picture (string)
categories	Array	Array with information about categories. Each object has the following properties: alias – category alias (string) id – category id (string) name – category name (string) parent – parent category id (string) url – category url (string)
filters	Array	Array with information about filters. Each object has the following properties: filter – filter object. Has the following properties: count – total count of products whith this parameters (number) values – array of values (object). Has the following properties: * value – value label. (string), count – cont of products whith this parameter (number)
html	String	HTML-code of the block with products. The template is customized in the Kameleoon personal account.
price_range	Object	Min and max price of products. Has the following properties: min – min price (number) max – max price (number)
products	Array	Array with information about products. Each object has the following properties: brand – product brand (string) currency – product currency (string, corresponds to the currency of the personal account in Kameleoon, or a custom value specified in the shop settings in the personal account) id – product ID (string) is_new – product property (boolean, default - null) name – product name (string) old_price – product old price (string, default - 0) picture – product’s picture URL in the Kameleoon storage (string) price – product price (number) price_formatted – product price with currency (string) url – product URL (string) Additional properties if a parameter “extended” is passed in the request: barcode – product barcode (string) categories – product categories (array). Has the following properties: id – category id (string) name – category name (string) parent – parent category id (string) params – array with information about params. Each object has the following properties: key – param name (string) values – array of values (array)
products_total	Number	Total count of products
search_query	String	Search query typed by the user.

obtainProductInteractions

Kameleoon.API.Products.obtainProductInteractions("123456", product => {
  console.log("product", product); // {123456: {views: 1, cartQuantities: 0, boughtQuantities: 0}}
});
Kameleoon.API.Products.obtainProductInteractions(["123456", "654321"], products => {
  console.log("products", products);
});
Kameleoon.API.Products.obtainProductInteractions(
  "123456",
  callback,
  new Date().getTime() - 1000 * 60 * 60 * 24, // timeBegin
  new Date().getTime() // timeEnd
);

The obtainProductInteractions() method retrieves interaction metrics for products tracked via trackProductView(), trackTransaction(), or trackAddToCart().

Arguments

Name	Type	Description
eans	Array	Product IDs (as Strings). This field is mandatory.
callback	Function	Callback function receiving the product data. This field is mandatory.
timeBegin	Number	Start of the date range (UNIX milliseconds timestamp).
timeEnd	Number	End of the date range (UNIX milliseconds timestamp).

API Response

Name	Type	Description
eans	Array	Unique identifier of the product. Each product ID maps to an object containing interaction metrics.
views	integer	Number of times the product has been viewed.
cartQuantities	integer	Total number of times the product has been added to visitors’ carts.
boughtQuantities	integer	Total number of times the product has been purchased.

obtainProductData

Kameleoon.API.Products.obtainProductData("123456", product => {
  console.log("product", product);
});
Kameleoon.API.Products.obtainProductData(["123456", "654321"], products => {
  console.log("products", products);
});
Kameleoon.API.Products.obtainProductData("123456", callback, {
  name: true,
  categoryId: true
}); // {123456: {name: '', categoryId: '' }}

The obtainProductData() method retrieves product information for items sent via trackProductView().

Arguments

Name	Type	Description
eans	Array	Product IDs (as Strings). This field is mandatory.
callback	Function	Callback function receiving the product data. This field is mandatory.
parameters	Object	Facultatif parameters to retrieve specific fields. Defaults to `{ all: true }`.

API Response

Name	Type	Description
eans	Array	Unique identifier of the product. Each product ID maps to an object containing interaction metrics.
productData	Object	Product object. The same object sent by `trackProductView` will be recieved in this field.

obtainRecommendedCollections

Kameleoon.API.Products.obtainRecommendedCollections("123456", collections => {
    /* The functionality of rendering a product collection block */
    console.log("collections", collections);
}, error => {
    /* Error handling logic if something goes wrong */
});

The obtainRecommendedCollections() method retrieves products de la specified collection.

Arguments

Name	Type	Description
collectionId	String	Product collection ID, available in the Product Collections dashboard section.
successCallback	Function	Callback function receiving the API response object. This field is mandatory.
errorCallback	Function	Callback function executing if an error occurs. This field is optional.

API response

Products

API retourne un array of objects. Each object in the products array contains the following:

Parameter	Type	Description
name	String	Nom du product
url	String (URL)	URL of the product page
description	String	Description of the product
category_ids	Tableau de Strings	Liste des category IDs the product belongs to
brand	String	Brand of the product
fashion_feature	String	Fashion feature (e.g., `"adult"`)
fashion_gender	String	Intended gender for the product
sales_rate	Integer	Product’s sales rate
relative_sales_rate	Float	Sales rate relative to other products
picture	String (URL)	URL of the main product image
categories	Tableau de Objects	Liste des category objects (system-defined structure)
price_formatted	String	Formatted product price (e.g., `$29.99`)
price_full_formatted	String	Formatted full/original price
price	Float	Current product price
price_full	Float	Original/full price before any discounts
image_url	String (URL)	URL of the resized product image
image_url_handle	String (URL)	Processed image URL (handle-based)
image_url_resized	String (URL)	Resized image URL
url_handle	String	URL handle used to access the product within the collection
currency	String	Currency code used for the product price (e.g., `USD`, `EUR`)
id	String	Product ID (numeric or string depending on system)
html	String (HTML)	The HTML template selected lorsque the collection was created

Kameleoon.API.Experiments

This module provides methods to access live experiments.

This module is only available with Kameleoon Web Experimentation solution.

assignVariation

var experimentID = 2468;
var variationID;

if (Kameleoon.API.CurrentVisit.device.type == "Desktop") {
  variationID = 123456;
} else if (Kameleoon.API.CurrentVisit.device.type == "Tablet") {
  variationID = 654321;
} else {
  variationID = 987654;
}

Kameleoon.API.Experiments.assignVariation(experimentID, variationID);

The assignVariation() method forces the association of a specific variation for une expérience, which overrides the standard allocation algorithm. Si vous call this before l’expérience triggers, le moteur pre-allocates lune variation for later activation. If l’expérience has already triggered, set the override argument to true to replace the existing association.

Arguments

Name	Type	Description
experimentID	Number	ID de l’expérience. This field is mandatory.
variationID	Number	ID de lune variation. This field is mandatory.
override	Boolean	Lorsque true, le moteur replaces any existing variation association with the provided value. Si omis, the method defaults to false.

block

// The experiment will be blocked for the current page
Kameleoon.API.Experiments.block(12345);

// The experiment will be blocked for the whole visit
Kameleoon.API.Experiments.block(54321, true);

The block() method prevents une expérience from triggering or activating, including manual calls through trigger(). The block applies to the current page by default until the next Kameleoon.API.Core.load(). Set the visit argument to true to block l’expérience for the entire visit.

Arguments

Name	Type	Description
experimentID	Number	ID de l’expérience. This field is mandatory.
visit	Boolean	Lorsque true, le moteur blocks l’expérience for the entire visit. Si omis, the block applies only to the current page (default: false).

getAll

Kameleoon.API.Experiments.getAll().forEach(function (experiment) {
  if (experiment.id == 123456 && experiment.active) {
    console.log(experiment.name);
  }
});

The getAll() method retourne all live experiments (running, not draft/paused/stopped).

Valeur de retour

Name	Type	Description
experiments	Array	Liste des Experiment objects.

getActive

if (Kameleoon.API.Experiments.getActive().length == 0) {
  Kameleoon.API.Events.trigger("No Experiments Events");
}

The getActive() method retourne active experiments pour le visit and page. An experiment is active if its variation code has executed in the current session context. To retrieve experiments that you activated on other URLs during the visit, use getActivatedInVisit().

Valeur de retour

Name	Type	Description
experiments	Array	Liste des Experiment objects.

getById

var experiment = Kameleoon.API.Experiments.getById(123456);

if (experiment && experiment.active) {
  console.log(experiment.name);
}

The getById() method retourne l’expérience for the specified ID.

Arguments

Name	Type	Description
id	Number	ID de l’expérience. This field is mandatory.

Valeur de retour

Name	Type	Description
experiment	Object	Experiment object.

getByName

var experiment = Kameleoon.API.Experiments.getByName("MyExperimentName");

if (experiment && experiment.active) {
  console.log(experiment.id);
}

The getByName() method retourne l’expérience for the specified name.

Arguments

Name	Type	Description
name	String	Nom de l’expérience. This field is mandatory.

Valeur de retour

Name	Type	Description
experiment	Object	Experiment objects.

getTriggeredInVisit

Kameleoon.API.Experiments.getTriggeredInVisit().forEach(function (experiment) {
  if (experiment.id == 123456) {
    console.log(experiment.name);
  }
});

The getTriggeredInVisit() method retourne all experiments déclenché during the current visit.

Valeur de retour

Name	Type	Description
experiments	Array	Liste des Experiment objects.

getActivatedInVisit

Kameleoon.API.Experiments.getActivatedInVisit().forEach(function (experiment) {
  if (experiment.id == 123456) {
    console.log(experiment.name);
  }
});

The getActivatedInVisit() method retourne all experiments activated during the current visit.

Valeur de retour

Name	Type	Description
experiments	Array	Liste des Experiment objects.

trigger

let experimentID = 123456;
Kameleoon.API.Experiments.trigger(experimentID, true);

The trigger() method forces une expérience to trigger, bypassing targeting segment conditions. This action initiates l’expérience but might not activate it.

Arguments

Name	Type	Description
experimentID	Number	ID de l’expérience. This field is mandatory.
trackingOnly	Boolean	Set to true for hybrid experiments (backend implementation with frontend tracking) to perform only tracking actions without executing variation assets (JS, CSS, redirections). Si omis, the method defaults to false.

Kameleoon.API.Personalizations

This module provides methods to access live personalizations.

disable

let personalizationID = 12345;
Kameleoon.API.Personalizations.disable(personalizationID);

The disable() method marks une personnalisation as disabled. Use this for interactive elements like pop-ins. Lorsque a user closes the element, call disable() to update la personnalisation status. Kameleoon automatically implements this call for native, non-custom interface elements.

Arguments

Name	Type	Description
id	Number	Id of la personnalisation. This field is mandatory.

getActive

if (Kameleoon.API.Personalizations.getActive().length == 0) {
  Kameleoon.API.Events.trigger("No Personalizations Events");
}

The getActive() method retourne active personalizations pour le visit and page. A personalization is active if its variation code has executed and the associated action remains visible. To retrieve personalizations that déclenché on other URLs or that are now closed, tel que pop-ins, use getTriggeredInVisit().

Valeur de retour

Name	Type	Description
personalizations	Array	Liste des Personalization objects.

getAll

Kameleoon.API.Personalizations.getAll().forEach(function (personalization) {
  if (personalization.id == 123456 && personalization.active) {
    console.log(personalization.name);
  }
});

The getAll() method retourne all live personalizations (running, not draft/paused/stopped).

Valeur de retour

Name	Type	Description
personalizations	Array	Liste des Personalization objects.

getById

var personalization = Kameleoon.API.Personalizations.getById(123456);

if (personalization && personalization.active) {
  console.log(personalization.name);
}

The getById() method retourne la personnalisation for the specified ID.

Arguments

Name	Type	Description
id	Number	Id of la personnalisation. This field is mandatory.

Valeur de retour

Name	Type	Description
personalization	Object	Personalization object.

getByName

var personalization = Kameleoon.API.Personalizations.getByName("MyPersonalizationName");

if (personalization && personalization.active) {
  console.log(personalization.id);
}

The getByName() method retourne la personnalisation for the specified name.

Arguments

Name	Type	Description
name	String	Name of la personnalisation. This field is mandatory.

Valeur de retour

Name	Type	Description
personalization	Object	Personalization object.

getTriggeredInVisit

Kameleoon.API.Personalizations.getTriggeredInVisit().forEach(function (personalization) {
  if (personalization.id == 123456) {
    console.log(personalization.name);
  }
});

The getTriggeredInVisit() method retourne all personalizations déclenché during the current visit.

Valeur de retour

Name	Type	Description
personalizations	Array	Liste des Personalization object.

getActivatedInVisit

Kameleoon.API.Personalizations.getActivatedInVisit().forEach(function (personalization) {
  if (personalization.id == 123456) {
    console.log(personalization.name);
  }
});

The getActivatedInVisit() method retourne all personalizations activated during the current visit.

Valeur de retour

Name	Type	Description
personalizations	Array	Liste des Personalization object.

trigger

let personalizationID = 123456;
Kameleoon.API.Personalizations.trigger(personalizationID, true);

The trigger() method forces une personnalisation to trigger, bypassing targeting segment conditions. This action initiates la personnalisation but might not activate it.

Arguments

Name	Type	Description
personalizationID	Number	ID of la personnalisation. This field is mandatory.
trackingOnly	Boolean	Set to true for external personalizations (targeting or tracking managed by Kameleoon) to perform only tracking actions without executing variation assets (JS, CSS, redirections). Si omis, the method defaults to false.

Kameleoon.API.Variations

This module provides methods to manage variations.

execute

if (Kameleoon.API.Utils.querySelectorAll("#KameleoonPopin").length == 0) {
  Kameleoon.API.Experiments.getById(123456).variations.forEach(function (variation) {
    if (variation.name == "MyVariation") {
      Kameleoon.API.Variations.execute(variation.id);
    }
  });
}

The execute() method executes JavaScript and applies CSS for the specified variation ID.

Kameleoon.API.Segments

This module provides methods to manage segments and targeting.

getAll

let segments = Kameleoon.API.Segments.getAll();

The getAll() method retourne all live segments, including those associé à experiments, personalizations, or Audience tracking.

Valeur de retour

Name	Type	Description
segments	Array	Liste des Segment objects.

getById

let segment = Kameleoon.API.Segments.getById(123456);

The getById() method retourne le segment for the specified ID.

Arguments

Name	Type	Description
id	Number	ID of le segment. This field is mandatory.

Valeur de retour

Name	Type	Description
segment	Object	Segment object.

getByName

let segment = Kameleoon.API.Segments.getByName("My segment");

The getByName() method retourne le segment for the specified name.

Arguments

Name	Type	Description
name	String	Name of le segment. This field is mandatory.

Valeur de retour

Name	Type	Description
segment	Object	Segment object.

reevaluate

Kameleoon.API.Utils.addEventListener(document.body, "mouseleave", function (event) {
  if (event.clientY < 0) {
    Kameleoon.API.Segments.reevaluate(123456);
  }
});

The reevaluate() method forces an immediate re-evaluation of the conditions de ciblage for the specified segment. Evaluation typically occurs at page load, resulting in statuses of true, false, or undefined. Cette méthode restarts the evaluation process as if le moteur just initialized.

Arguments

Name	Type	Description
id	Number	ID of le segment. This field is mandatory.

trigger

Kameleoon.API.Segments.trigger(12345);

The trigger() method forces un segment trigger for le visiteur actuel and bypasses conditions de ciblage.

Arguments

Name	Type	Description
id	Number	ID of le segment. This field is mandatory.

Kameleoon.API.Triggers

This module provides methods to manage déclenche and targeting.

getAll

let triggers = Kameleoon.API.Triggers.getAll();

The getAll() method retourne all live triggers, including those associé à experiments, personalizations, or Audience tracking.

Valeur de retour

Name	Type	Description
triggers	Array	Liste des Trigger objects.

getById

let trigger = Kameleoon.API.Triggers.getById(123456);

The getById() method retourne le trigger for the specified ID.

Arguments

Name	Type	Description
id	Number	ID du trigger. This field is mandatory.

Valeur de retour

Name	Type	Description
trigger	Object	Trigger object.

getByName

let trigger = Kameleoon.API.Triggers.getByName("My trigger");

The getByName() method retourne le trigger for the specified name.

Arguments

Name	Type	Description
name	String	Nom du trigger. This field is mandatory.

Valeur de retour

Name	Type	Description
trigger	Object	Trigger object.

reevaluate

Kameleoon.API.Utils.addEventListener(document.body, "mouseleave", function (event) {
  if (event.clientY < 0) {
    Kameleoon.API.Triggers.reevaluate(123456);
  }
});

The reevaluate() method forces an immediate re-evaluation of the conditions de ciblage for the specified trigger. Evaluation typically occurs at page load, resulting in statuses of true, false, or undefined. Cette méthode restarts the evaluation process as if le moteur just initialized.

Arguments

Name	Type	Description
id	Number	ID du trigger. This field is mandatory.

trigger

Kameleoon.API.Triggers.trigger(12345);

The trigger() method forces a trigger to fire for le visiteur actuel and bypasses conditions de ciblage.

Arguments

Name	Type	Description
id	Number	ID du trigger. This field is mandatory.

Kameleoon.API.Utils

This module provides utility methods for common operations.

addEventListener

var popin = document.createElement("div");
popin.id = "kameleoonPopin";
popin.innerHTML = "<img src='https://www.mywebsite.com/myImage.jpg'/>";
document.body.appendChild(popin);

Kameleoon.API.Utils.addEventListener(popin, "mousedown", function (event) {
  document.body.removeChild(popin);
});

The addEventListener() method attaches un événement handler to the specified element.

Kameleoon resets all event listeners created via this API during engine reloads. Utilisez cette méthode to add listeners in SPAs to ensure proper cleanup.

Arguments

Name	Type	Description
element	Object	Target element for the listener. This field is mandatory.
eventType	String	Event name. This field is mandatory.
callback	Function	Function to execute lorsque l’événement triggers. This field is mandatory.

addUniversalClickListener

let btn = document.querySelector("#MyButton");

Kameleoon.API.Utils.addUniversalClickListener(btn, function (event) {
  let goalID = 1234;
  Kameleoon.API.Goals.processConversion(goalID);
});

The addUniversalClickListener() method attaches a click handler that listens for mouse clicks on desktop and touchdown events on mobile devices and tablets. For mobile devices, a touchdown occurs if le moteur detects a touchstart event followed by a touchend event without an intermediate touchmove.

Kameleoon resets all listeners created via this API during engine reloads, facilitating cleanup in SPAs.

On desktop devices, right-clicks trigger this method (e.g., lorsque opening a link in a new tab).

Arguments

Name	Type	Description
element	Object	Target element for the listener. This field is mandatory.
callback	Function	Function to execute lorsque the click event triggers. This field is mandatory.

clearInterval

var myInterval = Kameleoon.API.Utils.setInterval(function () {
  if (window.dataLayer != null) {
    Kameleoon.API.Utils.clearInterval(myInterval);
  }
}, 1000);

The clearInterval() method clears a timer you set through setInterval().

Arguments

Name	Type	Description
intervalId	Number	Timer ID returned by the `setInterval()` method. This field is mandatory.

clearTimeout

var myTimeout = Kameleoon.API.Utils.setTimeout(function () {
  var popin = document.createElement("div");
  popin.id = "kameleoonPopin";
  popin.innerHTML = "<img src='https://www.mywebsite.com/myImage.jpg'/>";
  document.body.appendChild(popin);
}, 5000);

Kameleoon.API.Utils.addEventListener(document.body, "mousedown", function () {
  Kameleoon.API.Utils.clearTimeout(myTimeout);
});

The clearTimeout() method clears a timer you set through setTimeout().

Arguments

Name	Type	Description
timeoutId	Number	Timer ID returned by `setTimeout()`.

computeHash

var emailId = Kameleoon.API.Utils.createHash("myemail@mail.com");
Kameleoon.API.Data.setCustomData("VisitorEmail", emailId);

The computeHash() method computes a hash from a string. Use this to process unique data without manipulating sensitive personal information directly.

Arguments

Name	Type	Description
string	String	The source string from which to compute the hash.

Valeur de retour

Name	Type	Description
hash	String	Resulting hash. The algorithm used is the same as the implementation of `hashCode()` for java.lang.String.

getURLParameters

var parameters = Kameleoon.API.Utils.getURLParameters();

if (parameters.productID != null) {
  Kameleoon.API.Events.trigger("ProductPage");
}

The getURLParameters() method parses the current URL and retourne all detected parameters. Cette méthode supports both search (?) and hash (#) parameters.

Valeur de retour

Name	Type	Description
parameters	Object	Object with parameter names as keys and parameter values as values.

performRequest

Kameleoon.API.Utils.performRequest(
  "https://www.my_web_server_url.com",
  function () {
    if (this.readyState == 4 && this.status == 200) {
      eval(this.responseText);
    }
  },
  function() {
    console.log("Request cancelled");
  },
  2000
);

The performRequest() method initiates a call to a remote web server.

Arguments

Name	Type	Description
url	String	The URL of the remote server. This field is mandatory.
readyStateHandler	Function	A callback function that will be executed lorsque a reply is received de la server. The event argument is passed to this function (load event) and the underlying XMLHttpRequest object is bound to the callback. So all properties from XMLHttpRequest are available inside the callback via this. This field is optional.
errorHandler	Function	A callback function that will be called in case an error occurs. The event argument is passed to this function (error event or timeout event) and the underlying XMLHttpRequest object is bound to the callback. So all properties from XMLHttpRequest are available inside the callback via this. This field is optional.
timeout	Number	Wait time in milliseconds before cancelling the request. Defaults to 5000 milliseconds.

querySelectorAll

var foundElements = Kameleoon.API.Utils.querySelectorAll(".kameleoonClassName");

foundElements.forEach(function (element) {
  element.style.display = "none";
});

The querySelectorAll() method retourne all document elements matching the specified CSS selectors as a static NodeList object.

Cette méthode supports selectors with :contains and :eq.

Arguments

Name	Type	Description
selector	String	One or more CSS selectors. This field is mandatory.

Valeur de retour

Name	Type	Description
elements	Array	Liste des elements matching the query.

setInterval

var countdown = 10;
var timer = document.createElement("div");
timer.innerHTML = countdown.toString();
document.body.appendChild(timer);

var myInterval = Kameleoon.API.Utils.setInterval(function () {
  countdown--;
  timer.innerHTML = countdown.toString();

  if (countdown == 0) {
    Kameleoon.API.Utils.clearInterval(myInterval);
  }
}, 1000);

The setInterval() method executes a function or expression at the specified interval in milliseconds. Kameleoon resets all intervals created via this API during engine reloads. Utilisez cette méthode in SPAs to ensure proper cleanup.

Arguments

Name	Type	Description
function	Function	JavaScript function that will be executed periodically. This field is mandatory.
milliseconds	Number	Interval duration in milliseconds. Defaults to 200 milliseconds.

Valeur de retour

Name	Type	Description
intervalId	Number	Timer ID for use with `clearInterval()`.

setTimeout

var myTimeout = Kameleoon.API.Utils.setTimeout(function () {
  Kameleoon.API.Events.Trigger("5 seconds elapsed");
}, 5000);

The setTimeout() method executes a function or expression after the specified number of milliseconds. Kameleoon resets all timeouts created via this API during engine reloads. Utilisez cette méthode in SPAs to ensure proper cleanup.

Arguments

Name	Type	Description
function	Function	JavaScript function that will be executed periodically. This field is mandatory.
milliseconds	Number	Wait time in milliseconds before executing the function. Defaults to 200 milliseconds.

Valeur de retour

Name	Type	Description
timeoutId	Number	Timer ID for use with `clearTimeout()`.

Kameleoon.API.Visitor

This module provides a shortcut to obtain a reference to the current Visitor object. The Activation API contains a single, unique Visitor object. This module also allows you to override le visiteur code.

setVisitorCode

 // Setting up the Kameleoon VisitorCode Override

// Initialize the KameleoonQueue if it doesn't exist
window.kameleoonQueue = window.kameleoonQueue || [];

// Push the command to set the VisitorCode with your own ID

 window.kameleoonQueue.push({
    level: "IMMEDIATE",
    command: () => Kameleoon.API.Visitor.setVisitorCode("<USER_ID>")
 });

The setVisitorCode() method overrides the Kameleoon VisitorCode, which is a unique identifier randomly generated for every visitor. Ensure that your ID is unique and does not exceed 255 characters. Appelez ce method as early as possible, specifically before Kameleoon déclenche any experiments. Si vous update the VisitorCode after le moteur assigns une variation, le moteur reassigns lune variation.

Kameleoon.API.CurrentVisit

This module provides a shortcut to obtain a reference to the current, in-progress Visit object. It references the same object as Kameleoon.API.Visitor.visits[Kameleoon.API.Visitor.visits.length - 1].

Configuration

A Configuration object holds global constant values related to the current configuration of Kameleoon on this site.

Properties

Name	Type	Description
siteCode	String	The unique site code corresponding to the Kameleoon application file installed on the website. It is a string of 10 random characters (lower case letters and numerals).
singlePageSupport	Boolean	Set to true if Single Page Support is configured. Configuration occurs globally via the Kameleoon app or via `Kameleoon.API.Core.enableSinglePageSupport()`. Single Page Support ensures URL changes trigger `Kameleoon.API.Core.load()` without requiring a browser page reload.
goals	Array	Liste des Goal objects representing all the active (configured) goals for this site.
generationTime	Number	Time of the last generation of the Kameleoon application file (UTC format - ms since 1st January, 1970).

Visitor

A Visitor object contains visitor-scoped data independent of specific visits. This object includes a list of all Visit objects for le visiteur.

Properties

Name	Type	Description
code	String	The randomly generated visitor code. Unless a custom value has been specifically set on the server (via a Kameleoon server-side SDK), it is a string of 16 random characters (lower case letters and numerals).
numberOfVisits	Number	Total visits for le visiteur. This value may exceed `visits.length`, as the Activation API retains only the latest 25 visits.
firstVisitStartDate	Number	Start date (UNIX milliseconds) for the first visit. This value may not align with `visits[0].startDate`, as the Activation API retains only the latest 25 visits.
visits	Array	Liste des all the Visit objects made by this visitor on your website, with a maximum of 25 visits. If this visitor made more than 25 visits, only the latest 25 are available via this property.
currentVisit	Object	Visit object corresponding to the current, in-progress visit. This is a reference to the same object as Kameleoon.API.CurrentVisit.
previousVisit	Object	Visit object corresponding to the previous visit. Si lere was no previous visit (that is, the current visit is the first one), this property is null.
customData	Object	Map of all custom data with a VISITOR scope. The keys of the map are the defined custom data names. This map only includes custom data that you defined in the Kameleoon app with a VISITOR scope. Vous pouvez access other custom data from a Visit object.
experimentLegalConsent	Boolean	Lorsque true, le moteur obtained legal consent (or it is not required) for le visiteur to activate experiments. Cette propriété is null if le visiteur has not given or declined consent.
personalizationLegalConsent	Boolean	Lorsque true, le moteur obtained legal consent (or it is not required) for le visiteur to activate personalizations. Cette propriété is null if le visiteur has not given or declined consent.

Visit

A Visit object represents a single visit and contains real-time information that Kameleoon gathers. Data points include visit context (device, location), observed behavior (duration, page views), and Kameleoon operations, tel que déclenché experiments or personalizations.

Properties

Name	Type	Description
index	Number	Index of the visit. The first visit of a given visitor has an index of 0. Because the Activation API retains only the latest 25 visits, `Kameleoon.API.Visitor.visits[0].index` might not equal 0.
startDate	Number	Date (UTC format - ms since 1st January, 1970) of the start of the visit.
duration	Number	Duration of this visit in ms. If this visit is the current visit, this value is always up to date (it is recomputed each time it is accessed).
pageViews	Number	Number of pages viewed during the visit. In SPAs, calling `Kameleoon.API.Core.load()` increments this number. URL changes automatically trigger this call if Single Page Support is enabled.
locale	String	The locale of le visiteur’s browser.
device	Object	Device object corresponding to le visiteur’s device for this visit.
geolocation	Object	Geolocation object corresponding to le visiteur’s location for this visit.
weather	Object	Weather object corresponding to le visiteur’s weather for this visit.
activatedExperiments	Array	Liste des ExperimentActivation objects, corresponding to all l’expériences that were activated on this visit.
activatedPersonalizations	Array	Liste des PersonalizationActivation objects, corresponding to all la personnalisations that were activated on this visit.
conversions	Object	Map of conversions performed on this visit. The keys of the map are the defined goal IDs. The values are Objects with two keys: count (number of times this goal was converted for this visit) and revenue (total revenue of this goal for this visit).
customData	Object	Map of all custom data with a PAGE or VISIT scope. The keys of the map are the defined custom data names. This map only includes custom data that you defined in the Kameleoon app with a PAGE or VISIT scope. Vous pouvez access other custom data de la Visitor object.
currentProduct	Object	Product object corresponding to the product displayed on the current product page. If le visiteur is currently not on a product page, this property is null.
products	Array	Liste des Product objects, corresponding to all the product pages that were seen on this visit (including the currentProduct if applicable).
acquisitionChannel	String	Nom du acquisition channel for the visit. The list of acquisition channels, along with their characteristics (mainly how they can be inferred, for instance by URL parameter), are defined using the Kameleoon app.
landingPageURL	String	URL of the first page of the visit, usually called the landing page.
initialConversionPredictions	Object	Map of Kameleoon Conversion Scores (KCS). The keys of the map are the defined key moment names. The values range from 0 to 100, representing the KCS for the designated key moment. (Note: Kameleoon recently changed “key moment” to “triggers” in the Kameleoon app.)

The kameleoonConversionScores property is only available with the AI Predictive Targeting add-on.

Device

A Device object contains data about the device for a given visit.

Properties

Name	Type	Description
browser	String	Nom du browser. Possible values are: Chrome, Chromium, Firefox, Safari, Microsoft Edge, Internet Explorer, Opera, Android, iPhone, iPad, iPod, Samsung Internet for Android, Opera Coast, Yandex Browser, UC Browser, Maxthon, Epiphany, Puffin, Sleipnir, K-Meleon, Windows Phone, Vivaldi, Sailfish, SeaMonkey, Amazon Silk, PhantomJS, SlimerJS, BlackBerry, WebOS, Bada, Tizen, QupZilla, Googlebot, Blink, Gecko, Webkit.
browserVersion	String	Version of the browser.
os	String	Nom du OS. Possible values are: Windows, Mac, Linux, Android, iOS, Chrome OS, Windows Phone.
type	String	Type of the device. Possible values are: Desktop, Tablet, Phone.
screenHeight	Number	Height of the device’s screen (in pixels).
screenWidth	String	Width of the device’s screen (in pixels).
windowHeight	Number	Height of the browser’s window (in pixels).
windowWidth	String	Width of the browser’s window (in pixels).
adBlocker	Boolean	Boolean equal to true if this device has an active ad blocker, else to false.
timeZone	String	Time zone of the browser. The value is a string (for example, “Europe/Paris”) that corresponds to the TZ database of time zones.

Geolocation

A Geolocation object contains data about the physical location of le visiteur for a given visit.

Properties

Name	Type	Description
country	String	Country name, in English.
region	String	Nom du region, in the country’s preferred language.
city	String	Nom du city, in the country’s preferred language.
postalCode	String	Postal code.
latitude	Number	Latitude (in degrees).
longitude	Number	Longitude (in degrees).

Weather

A Weather object contains data about the weather conditions occurring at the time of the visit.

Properties

Name	Type	Description
temperature	String	Temperature in Kelvin.
humidity	String	Humidity in percentage (from 0 to 100).
pressure	String	Atmospheric pressure in hPa.
windSpeed	String	Wind speed in meters/sec.
cloudiness	Number	Cloudiness in percentage (from 0 to 100).
sunrise	Number	Time of sunrise (UTC format - ms since 1st January, 1970).
sunset	Number	Time of sunset (UTC format - ms since 1st January, 1970).
conditionCode	Number	Weather condition ID code. Full reference list est disponible here.
conditionDescription	String	Weather condition description that matches the `conditionCode`. Par exemple, a `conditionCode` of 800 has a `conditionDescription` of clear sky.

Experiment

An Experiment object represents a Kameleoon A/B test. Core properties include le segment and associated variations. Variations contain the JavaScript and CSS code that implements the changes.

Properties

Name	Type	Description
id	Number	ID de l’expérience.
name	String	Nom de l’expérience.
dateLaunched	Number	Time of first launch of l’expérience (UTC format - ms since 1st January, 1970).
dateModified	Number	Time of last modification of l’expérience (UTC format - ms since 1st January, 1970).
targetSegment	Object	Segment object associé à l’expérience.
variations	Array	Liste des Variation objects for this experiment.
trafficDeviation	Object	Map of current experiment traffic deviation. Keys are variation IDs (ID 0 is the reference). Values are percentages (0-100). The sum may not equal 100 if a portion of traffic is unallocated.
untrackedTrafficReallocationTime	Number	Time of the last reallocation performed for untracked traffic (UTC format - ms since 1st January, 1970). Si un reallocation was never performed, the value will be null.
goals	Array	Liste des Goal objects tracked for l’expérience.
mainGoal	Object	Goal object representing the main goal of l’expérience.
triggered	Boolean	Boolean equal to true if l’expérience was déclenché on la page, else to false.
active	Boolean	Boolean equal to true if l’expérience is actuellement actif on la page, else to false.
triggeredInVisit	Boolean	Boolean equal to true if l’expérience was déclenché in the current visit, else to false. This means that the visit fulfilled l’expérience’s segment conditions at some point.
activatedInVisit	Boolean	Lorsque true, le moteur activated l’expérience during the current visit. A déclenché experiment does not guarantee activation; factors like traffic exclusion or capping can prevent activation.
nonExpositionReason	String	If le moteur déclenché but did not activate l’expérience, this field represents the reason. Possible values: `EXPERIMENT_EXCLUSION` (le visiteur belongs to the population excluded de la experiment, that is, they are not counted towards results) and `VISITOR_CAPPING` (le visiteur reached a capping limit that prevents activation). Cette propriété est disponible if le moteur déclenché l’expérience on the current page and `active` is false.
associatedVariation	Object	Variation object associé à l’expérience for the given visitor. If l’expérience is not yet activated, this will usually be null, except if a pre-allocation was performed.
redirectProcessed	Boolean	Lorsque true, a URL redirection occurred for this experiment on the previous page. Cette propriété is set through processRedirect() or manual configuration. In JavaScript-based integrations, redirects can cancel further code execution; check this property to resend network requests on the landing page if necessary.

Personalization

A Personalization object represents a Kameleoon personalization action for a specific segment. Core properties include le segment and the associated single variation. The Variation object contains the JavaScript and CSS code that implements la personnalisation action.

Properties

Name	Type	Description
id	Number	ID of la personnalisation.
name	String	Name of la personnalisation.
dateLaunched	Number	Time of first launch of la personnalisation (UTC format - ms since 1st January, 1970).
dateModified	Number	Time of last modification of la personnalisation (UTC format - ms since 1st January, 1970).
targetSegment	Object	Segment object associé à la personnalisation.
goals	Array	Liste des Goal objects tracked for la personnalisation.
mainGoal	Object	Goal object representing the main goal of la personnalisation.
triggered	Boolean	Lorsque true, la personnalisation déclenché on la page.
active	Boolean	Lorsque true, la personnalisation is active (displayed) on la page.
triggeredInVisit	Boolean	Lorsque true, la personnalisation déclenché during the current visit. This indicates that the visit fulfilled la personnalisation’s segment conditions.
activatedInVisit	Boolean	Lorsque true, le moteur displayed la personnalisation’s action during the current visit. Triggering une personnalisation does not guarantee that le moteur displays the action; for example, capping options or control group membership can prevent display.
nonExpositionReason	String	Reason for non-exposition if déclenché but not displayed. Possible values: `GLOBAL_EXCLUSION`, `PERSONALIZATION_EXCLUSION`, `PRIORITY`, `SCHEDULE`, `PERSONALIZATION_CAPPING`, `VISITOR_CAPPING`, `SCENARIO`, and `SIMULATION`. Cette propriété est disponible if la personnalisation déclenché on the current page and `active` is false.
associatedVariation	Object	Associated Variation object. Cette propriété always references a valid object for personalizations.

ExperimentActivation

An ExperimentActivation object represents une expérience activated during a specific visit. Because visits can be historical, the associated experiment might have stopped. In such cases, le moteur does not inject experiment metadata (name, launch date, segment) into the application file, which makes it unavailable through the API. Cependant, IDs remaining available.

Properties

Name	Type	Description
experimentID	Number	ID de l’expérience.
associatedVariationID	Number	ID du associated variation. Si le associated variation is the reference (control), the ID is equal to 0.
associatedVariation	Object	Associated Variation object. Cette propriété is null if l’expérience or variation is no longer active (stopped or paused).
times	Array	Liste des activation times for this experiment on this visit (UTC format - ms since 1st January, 1970).

PersonalizationActivation

A PersonalizationActivation object represents une personnalisation activated during a specific visit. As with experiments, metadata is unavailable if la personnalisation has stopped, although IDs remain accessible.

Properties

Name	Type	Description
personalizationID	Number	ID of la personnalisation.
associatedVariationID	Number	ID du associated variation.
personalization	Object	Associated Personalization object. Cette propriété is null if la personnalisation is no longer active (stopped or paused).
associatedVariation	Object	Associated Variation object. Cette propriété is null if la personnalisation or variation is no longer active (stopped or paused).
times	Array	Liste des activation times for this personalization on this visit (UTC format - ms since 1st January, 1970).

Variation

A Variation object represents a component of an Experiment. An A/B test contains multiple variations, tel que an A/B test with one variation plus reference or an A/B/C test with two plus reference. Personalizations associate with a single Variation object.

During variation code execution, the this keyword references the corresponding Variation object. Use this reference to navigate the object hierarchy (for example, through the associatedCampaign property).

Properties

Name	Type	Description
id	Number	Unique id of lune variation. If lune variation represents the reference (control), the ID is equal to 0.
name	String	Nom de lune variation. If lune variation represents the reference (control), the name is equal to “Reference”.
associatedCampaign	Object	The Experiment or Personalization object linked to this variation.
instantiatedTemplate	Object	Instantiated template object from which this variation was built, if applicable. If lune variation was not built from a template, this property is null.
reallocationTime	Number	Time of the last traffic reallocation performed for lune variation (UTC format - ms since 1st January, 1970). Si un reallocation was never performed, the value will be null.

Template

A Template object represents an instantiated Widget template. Use templates to generate variations from a common codebase through the Kameleoon app interface. A Template object contains predefined fields and their values for the associated variation.

Properties

Name	Type	Description
name	String	Nom du base template.
customFields	Object	Map corresponding to the template data. The keys are the names of the fields defined in the base template. The values are the instantiated values that you entered for the associated variation. Par exemple, si vous created a template with a single text field “currentDiscount”, `customFields` could equal `{"currentDiscount": "-10% on all orders today!"}`.

Goal

A Goal object represents a Key Performance Indicator (KPI) defined in the Kameleoon app.

Properties

Name	Type	Description
id	Number	ID of l’objectif.
name	String	Name of l’objectif.
type	String	Type of l’objectif. Possible values are: CLICK, SCROLL, URL, ENGAGEMENT and CUSTOM.

Segment

A Segment object contains criteria that a visit must fulfill to belong to le segment. On the Kameleoon platform, segments include constant conditions, tel que age or location, and triggering conditions, tel que time on page or cart contents.

Properties

Name	Type	Description
id	Number	ID of le segment.
name	String	Name of le segment.

Trigger

A Trigger object contains criteria that a visit must fulfill to fire the trigger. On the Kameleoon platform, déclenche include constant conditions, tel que age or location, and triggering conditions, tel que time on page or cart contents.

Properties

Name	Type	Description
id	Number	ID du trigger.
name	String	Nom du trigger.

Product

A Product object describes items in a catalog. Most properties are optional and might be null.

Properties

Name	Type	Requis	Description
id	String	True	Unique ID du product.
name	String	False	Nom du product.
sku	String	False	Stock Keeping Unit (SKU) of the product.
categories	Array	False	Liste des Category objects
imageURL	String	False	The URL of the main image for this product.
price	Number	False	The current price of the product.
oldPrice	Number	False	The original price of the product, usually before discounts or promotions.
brand	String	False	Nom du product’s brand.
description	String	False	Textual description of the product.
available	Boolean	False	Indication whether the product is in stock.
availableQuantity	Number	False	Current stock of the product.
rating	Number	False	Rating (usually from 0 to 5, but can be any number) attributed to the product.
tags	Array	False	Liste des tags (as Strings) for this product.
typePrefix	String	False	Product type, tel que “mobile phone” or “washing machine”. Used by search algorithms.
merchantID	String	False	Seller / merchant ID of this product if your website operates a marketplace.
groupId	String	False	Use this field to combine product variants into one group.
model	String	False	Model of the product.
leftovers	String	False	Inventory for a particular product. Use one of the following values: `one` (one copy available), `few` (limited quantities, up to 10 units), or `lot` (10 or more units available).
priceMargin	Number	False	A weighting factor of the product price margin, between 0 and 100.
isFashion	Boolean	False	Set to `true` for clothing products.
isChild	Boolean	False	Use this field if child product.
isNew	Boolean	False	Use this field if new product.
accessories	Array	False	Tableau de product IDs that can be complementary or equivalent to the current product.
seasonality	Array	False	Tableau de integers (months: 1-12).
params	Array	False	Liste des Param objects
fashion	Object	False	Fashion object
auto	Object	False	Auto object

Param

An optional generic field that allows you to upload custom information about a product that does not fit in other fields. Par exemple, this information could be the membership status required to buy a product or departure and return dates for a travel circuit.

Properties

Name	Type	Requis	Description
name	String	True	Nom du param.
value	Array	True	Liste des value (as Strings).
unit	String	False	Use two-character abbreviations for SI units, tel que cm (centimeters), wt (watts), or gr (grams).

Fashion

An optional generic field that allows you to upload custom information about the product.

Properties

Name	Type	Description
gender	String	Must be “f” (Female) or “m” (Male).
type	String	Product type. Possible values: `shoe`, `shirt`, `tshirt`, `underwear`, `trouser`, `jacket`, `blazer`, `sock`, `belt`, `hat`, `glove`.
feature	String	Use this field to indicate if the product is for adults or kids only. Must take the value “child” or “adult”.
colors	Array	Liste des Color objects.

Color

Properties

Name	Type	Description
color	String	Product colors.
picture	String	The URL of the picture.

Auto

An optional generic field that allows you to upload custom information about the product.

Properties

Name	Type	Description
vds	Array	Array that contains the Vehicle Identification Numbers (VIN) that serves as the car’s fingerprint.
compatibility	Array	Contains a list of Compatible objects

Compatible

Properties

Name	Type	Requis	Description
brand	String	True	Car brand name.
model	String	False	Car model name.

Vue d'ensemble

Événements de l'Activation API

⌘I

​Kameleoon.API.Core

​enableLegalConsent

Arguments

​disableLegalConsent

Arguments

​enableSinglePageSupport

​enableDynamicRefresh

​getConfiguration

Valeur de retour

​load

​processRedirect

Arguments

​runWhenConditionTrue

Arguments

​runWhenElementPresent

Arguments

​runWhenShadowRootElementPresent

​Arguments

​Kameleoon.API.Goals

​cancelConversion

Arguments

​processConversion

Arguments

​triggerGoal (Custom Code for Custom Goal)

Arguments

​Kameleoon.API.Data

​readLocalData

Arguments

Valeur de retour

​performRemoteSynchronization

Arguments

​resetCustomData

Arguments

​retrieveDataFromRemoteSource

Arguments

​setCustomData

Arguments

​writeLocalData

Arguments

​Kameleoon.API.Events

​trigger

Arguments

​Kameleoon.API.Tracking

​processOmniture

Arguments

​Kameleoon.API.Products

​obtainRecommendedProducts

Arguments

​Parameters to control the data returned by the recommendation platform

​API response

​trackAddToCart

Arguments

​Parameters for the recommendation platform

​trackAddToWishList

​trackCategoryView

Arguments

​trackProductView

Arguments

​trackSearchQuery

Arguments

​trackTransaction

Arguments

Additional parameters for trackTransaction

​obtainInstantSearchProducts

Arguments

​API response

​obtainFullSearchProducts

Arguments

Parameters to filter results

​API response

​obtainProductInteractions

Arguments

API Response

​obtainProductData

Arguments

API Response

​obtainRecommendedCollections

Arguments

​API response

Products

Kameleoon.API.Core

enableLegalConsent

disableLegalConsent

enableSinglePageSupport

enableDynamicRefresh

getConfiguration

load

processRedirect

runWhenConditionTrue

runWhenElementPresent

runWhenShadowRootElementPresent

Arguments

Kameleoon.API.Goals

cancelConversion

processConversion

triggerGoal (Custom Code for Custom Goal)

Kameleoon.API.Data

readLocalData

performRemoteSynchronization

resetCustomData

retrieveDataFromRemoteSource

setCustomData

writeLocalData

Kameleoon.API.Events

trigger

Kameleoon.API.Tracking

processOmniture

Kameleoon.API.Products

obtainRecommendedProducts

Parameters to control the data returned by the recommendation platform

API response

trackAddToCart

Parameters for the recommendation platform

trackAddToWishList

trackCategoryView

trackProductView

trackSearchQuery

trackTransaction

obtainInstantSearchProducts

API response

obtainFullSearchProducts

API response

obtainProductInteractions

obtainProductData

obtainRecommendedCollections

API response

Kameleoon.API.Experiments

assignVariation

block

getAll

getActive

getById

getByName

getTriggeredInVisit

getActivatedInVisit

trigger

Kameleoon.API.Personalizations

disable

getActive

getAll

getById

getByName

getTriggeredInVisit

getActivatedInVisit

trigger

Kameleoon.API.Variations

execute

Kameleoon.API.Segments

getAll

getById

getByName

reevaluate

trigger

Kameleoon.API.Triggers

getAll

getById

getByName

reevaluate