Skip to main content
A Kameleoon project connects one website, web app, or mobile app to your account. Each project has its own sitecode, settings, goals, and reporting data, so you configure how Kameleoon behaves on each property separately. You manage all projects from the Projects page in the Admin section. To add a project, see Create a project.

Projects page

The Projects page lists every project in your account. To open it:
  1. Log in to your Kameleoon account.
  2. Click Admin > Projects.
By default, the list shows the Project name, Sitecode, Type, and Status of each project. A color marker next to each name identifies the project, and the search bar at the top of the list shows the total number of projects.
The Projects page listing four projects, with the Filters panel open on the right
To find a project, enter its name, URL, or sitecode in the Search by project, URL or sitecode bar. Each row has two actions:
The Edit action and the three-dots menu on a project row
A project has one of three statuses:
  • Enabled: The project’s setup is complete. A project becomes Enabled when you click Complete setup at the end of the project setup steps.
  • Draft: The project’s setup isn’t complete. Kameleoon saves a project as a draft when you click Save for later in the new project flow. To finish a draft, click Edit on the project’s row, then complete its required information in the project creation flow.
  • Disabled: You turned off Kameleoon on the project with Disable. See Disable a project. To turn Kameleoon back on, see Enable a project.

Filter projects

The side panel to the right of the list has a Filters tab and a Columns tab. To filter the list:
  1. In the side panel, click Filters.
  2. Select one or more values in any of the following groups:
    • Status: Enabled, Draft, or Disabled.
    • Type: All campaign types, Web Experimentation, Feature Experimentation, or Mobile app.
    • Key dates: Last update or Created at.
  3. Click Apply.
The Filters tab with the Status, Type, and Key dates groups

Choose columns and sorting

To change which columns the list displays and how it sorts:
  1. In the side panel, click Columns.
  2. Under Display, select the columns to show. Available columns are Project name (always shown), Sitecode, Type, Status, Active campaigns, Last update, Created at, and Tags. Drag a column’s handle to change its position.
  3. Under Sort by, select the column to sort on and the order, for example Created at and From newest to oldest.
  4. Click Apply.
The Columns tab with the Display column list and the Sort by dropdowns

Project page

The project page holds every setting for one project. To open it, click Edit on the project’s row in the Projects page. The header of the project page shows the following information:
  • The project name, with its color marker.
  • Main domain: The main domain of the project.
  • Sitecode: The unique code that identifies the project. Click the copy button to copy it.
  • Project ID: The numeric identifier of the project. Click the copy button to copy it.
  • Status: The current status of the project. A project with the Enabled status shows Active.
The project page header and the Overview tab with the Main information section
Below the header, six tabs group the project’s settings:

Project actions

The three-dots menu in the top right of the project page offers the following actions:
  • Edit: Edit the project’s main information. See Overview tab.
  • Activity: Open the activity log, filtered to this project.
  • Live events: Open Live events for this project’s sitecode.
  • Disable: Disable Kameleoon on the project.
  • Delete: Remove the project from your Kameleoon account.
The project page three-dots menu with Edit, Activity, Live events, Disable, and Delete
You can also Disable or Delete a project from the three-dots menu on its row in the Projects page.
The three-dots menu on a project row with Disable and Delete

Disable a project

Disabling a project deactivates all of its experiments and personalizations. They resume automatically once you re-enable Kameleoon on the project. To disable a project:
  1. Click Disable in the project page’s three-dots menu, or in the three-dots menu on the project’s row in the Projects page. A pop-in opens.
  2. In the pop-in, enter the project’s sitecode in the text field.
  3. Click Disable.
Upon disabling, the Kameleoon application file (engine.js) is almost entirely stripped of its content, although the Kameleoon object remains defined. Some methods within the Activation API may not function correctly in this state, particularly those in the Experiments, Feature Flags, and Personalizations objects. If you call Activation API methods outside Kameleoon, Kameleoon strongly recommends using the Kameleoon CommandQueue to prevent errors on your website. Additionally, disabling Kameleoon doesn’t instantly stop your web campaigns. Because the browser may cache the script, returning visitors who have already downloaded a previous version continue to use it until their browser cache expires.

Enable a project

To turn Kameleoon back on for a disabled project:
  1. Click Edit on the project’s row in the Projects page.
  2. In the project page’s three-dots menu, click Enable.
The project’s experiments and personalizations then resume automatically.

Delete a project

Deleting a project removes it from your Kameleoon account. To delete a project:
  1. Click Delete in the project page’s three-dots menu, or in the three-dots menu on the project’s row in the Projects page. A pop-in opens.
  2. In the pop-in, enter the project’s sitecode in the text field.
  3. Click Delete project.

Overview tab

The Overview tab shows the project’s main information:
  • Project type: For example, Web Experimentation.
  • Description: The description you entered for the project.
  • Tags: The tags you added to the project.
  • Created: The date you created the project.
  • Last update: The date of the last change to the project.
To edit the main information:
  1. In the Main information section, click Edit.
  2. Update the fields you entered when you created the project: Main project domain, Color, Project name, Description, and Tags. See Add a new project for a description of each field.
  3. Click Save changes.
The Main information form with the main project domain, color, name, description, and tag fields

Settings tab

The Settings tab controls project-wide behavior in four sections: Campaign display, Data, Editor & preview mode, and SDK. Each section has an Edit button. To change a setting, click Edit, update the values in the form that opens, and click Save changes. To discard your changes, click Cancel.
The Settings tab with the Campaign display, Data, and Editor & preview mode sections
Clicking Edit in any section opens one form that contains the fields of every section, with Cancel and Save changes at the bottom of the page.
The Settings form with editable fields for campaign display and data settings

Campaign display

The Campaign display section has the following settings:
  • Behavior if timeout occurs: Defines what Kameleoon does when the Kameleoon application file exceeds its usual loading time. By default, Kameleoon uses Run Kameleoon (with flicker), which launches Kameleoon late and can cause a flicker effect. The other options are Disable Kameleoon for the current page and Disable Kameleoon for the entire visit. See flicker management and performance for details.
  • Isolate widget styles from your site (shadow DOM): Generates the code of all graphic widgets using JavaScript with shadow DOM, which isolates the widgets’ CSS from the CSS used on your website and avoids incompatibility. If you activate this option, widgets already used in a campaign automatically update when the campaign status changes. If you use CSS class names from your website in your widgets, styles may not apply correctly.
  • Forbid simultaneous display of personalizations of the same type: By default, Kameleoon allows the display of more than one similar personalization on a page (for example, two pop-ins or two images inserted in the same place). Turn this option on to prevent simultaneous display.

Data

The Data section has the following settings:
  • Attribution window: The period of time during which Kameleoon attributes a visitor’s conversions and revenue to a given variation. Enter the duration in days and hours. By default, the window is 7 days. Learn more about attribution windows.
  • Currency: By default, the country associated with your account determines currency settings. To change the currency for a project, select a currency from the dropdown.
  • Exclude certain IP addresses from reporting: When you turn on this option, Kameleoon no longer counts visitors associated with the IP addresses you enter in the Results pages of the tests you run on the project.
    • Use this option primarily to exclude your office IP address or other internal IPs that might interfere with accurate test results. Because Kameleoon performs the exclusion client-side, don’t include personal IP addresses in the exclusion list.
    • The exclusion only applies to Kameleoon events and the Results pages in the Kameleoon platform. Excluded visitors’ events can still reach Google Analytics 4 and other integrations, since Kameleoon doesn’t apply the same filtering to integration tracking.
    • The exclusion starts when you save it. Kameleoon stops sending data for visitors on the entered IP addresses from that point on. Data collected before you added an address stays in your Results pages, because Kameleoon can’t identify which earlier visitors used that address.
  • Data retention period: The period for which Kameleoon retains the project’s data.
The Data section has one more setting that applies only to A/B tests and feature experiments:
  • Minimum reliability threshold to determine a winning variation: The percentage that a variation’s reliability must exceed for Kameleoon to present it as the winner. For example, a threshold of 95% means you accept a maximum of 5% false-positive results. Kameleoon can’t present variations with lower reliability than this rate as winning variations in your results, regardless of their conversions. Because the reliability score affects the results Kameleoon presents, change this setting sparingly.

Editor & preview mode

The Editor & preview mode section has the following settings:
  • Enable launching the editor via Shift + F2: Lets you open the Kameleoon editor on your website with the keyboard shortcut Shift + F2. By default, the option is on.
  • Use the ”#” symbol in Kameleoon URL parameters: Some Kameleoon features (simulation links, Graphic editor) require additional parameters in your website URLs. By default, Kameleoon appends those parameters after a ? symbol. Some websites are incompatible with this syntax, while others are incompatible with the # symbol. Turn this option on to switch to a # symbol if you notice issues with the default behavior. The setting only concerns URLs changed while you or another authorized user operates Kameleoon. Kameleoon never changes URLs for your visitors.

SDK

The SDK section has the following settings:
  • SDK configuration update mode: Defines how SDKs obtain an updated configuration when you change a feature flag or turn it on or off. With Polling, the default, the SDK regularly requests the most recent configuration from the Kameleoon CDN. Streaming is available only if you have subscribed to the Real-time Streaming Architecture add-on. With streaming, Kameleoon notifies the SDK of configuration changes in real time through server-sent events (SSE), without any delay. See technical considerations for details.
  • Enable bot filtering (for server-side SDK): Filters bot traffic from the results of server-side experiments. Pass the visitor’s user agent to Kameleoon through the SDK so that Kameleoon can filter it. See how Kameleoon filters bot traffic from your results.
The Consent tab defines the consent policy for each type of campaign in the project. It has three sections, each with its own Edit button:
  • For A/B tests and feature experiments
  • For personalizations
  • For product recommendation
The Consent tab with the three consent policy sections
In each section, the Consent policy field offers Consent required and Consent not required. In all three sections, the field also offers IAB TCF 2.3 consent when you enable the IAB TCF integration. When you select Consent required for A/B tests and feature experiments or for personalizations, the Behavior when consent is unknown and Behavior on opt-out fields appear. The For product recommendation section has only the Consent policy field. To learn how to choose each value, see Consent management.

Scripts tab

The Scripts tab holds two script fields, each with its own Edit button: Global custom script and Variation selection script.
The Scripts tab with the Global custom script and Variation selection script editors

Global custom script

The global custom script is a JavaScript snippet that Kameleoon injects at the global level of a project. To edit it, open the Scripts tab, click Edit next to Global custom script, change the code in the editor, and click Save changes. The global script:
  • Runs on every page where the Kameleoon tag loads, before all experiments, personalizations, segments, and triggers.
  • Defines variables, helper functions, or tracking code that should be available across all experiments in the project.
  • Acts as a central location to manage shared code and avoid duplication.
Typical use cases include:
  • Defining global variables (for example, values from the dataLayer, device type).
  • Creating reusable utility functions (for example, date formatting, logging).
  • Converting custom goals (for example, revenue, add to cart) and setting custom data.
  • Triggering events for targeting.
  • Handling consent logic.
Best practices:
  • Keep the script lightweight and optimized to avoid performance issues.
  • Document the contents of your global script, because it affects the entire project.
Recommended structure:

Variation selection script

A variation selection script forces a variation’s display based on specific rules. To use one, click Edit next to Variation selection script, enter the complete script code, and click Save changes.

PBX tab

The PBX tab configures how Prompt-Based Experimentation (PBX) behaves for the project. It has two sections, each with its own Edit button.
The PBX tab with the PBX Build and PBX Ideate sections

PBX Build

The PBX Build section has the following settings:
  • Master prompt: Instructions that PBX adds to every request in the project. See Master Prompts.
  • Allow users to skip the master prompt: When you turn on this option, users can choose not to apply the master prompt to a request.
  • Responsive website: Indicates whether your website automatically adapts to different screen sizes. Turn off this option if your site uses a separate mobile version that doesn’t appear when you resize the browser window. When the option is off, PBX refreshes the preview when you switch device sizes to ensure the correct version displays.
The PBX Build form with the Master prompt, skip, and Responsive website settings

PBX Ideate

The PBX Ideate section has one setting:
  • Project context: A description of your brand, audience, tone, and any constraints, up to 5,000 characters. PBX Ideate uses it to produce more relevant suggestions on every analysis. See Define project context.
The PBX Ideate form with the Project context text box

Setup tab

The Setup tab shows how you installed Kameleoon on the project. It has three parts:
  • Code snippet to add to your page: The installation snippet that Kameleoon generated from your configuration. Click Copy to copy it.
  • Installation method: The Script installation type and the Loading mode.
  • Technical configuration: Dynamic tracking, resource hosting, and domain settings.
The Setup tab with the code snippet, Installation method, and Technical configuration sections
To change the installation of a Web Experimentation or All campaign types project, click Edit in the Installation method or Technical configuration section. A form opens with the steps Installation method, Technical configuration (skipped for Shopify), and Checklist. Use Back and Next to move between steps, and click Save changes to save. The project setup steps describe each step and its options.
Repeat the setup for each project, and don’t reuse a code snippet between projects. Kameleoon’s reporting tools and goals are specific to a single project, and you must track the performance of each project separately.

FAQ

In the Kameleoon appIn the left sidebar, click Admin > Projects. Your sitecode appears in the Sitecode column of the project list. The header of each project page also shows it.
The Projects page with the Sitecode column
In the Kameleoon Debug Assistant extensionYou can also find your sitecode on the extension dashboard. Click the + icon to add inserts, then add the Site Code insert.
Finding the sitecode in the Debug Assistant extension
Why turn off the script
  • You want to minimize page load times when not using Kameleoon.
  • You don’t use Kameleoon continuously.
Turn off the script
  1. Click Admin > Projects, then click Edit on your project’s row.
  2. Click the three-dots menu in the top-right corner, then click Disable.
  3. In the pop-in, enter the project’s sitecode in the text field, then click Disable.
To re-enable the script, open the same menu and click Enable.Turn off the script on a specific URLTo prevent Kameleoon from loading on a specific page, add ?kameleoonDisabled=true to the end of the URL.
You can turn off the Kameleoon editor shortcut in the app.Turn off the shortcut
  1. Click Admin > Projects.
  2. Click Edit on your project’s row.
  3. On the Settings tab, click Edit in the Editor & preview mode section.
  4. Toggle Enable launching the editor via Shift + F2 to OFF.
  5. Click Save changes.
Launch Kameleoon without the shortcutAfter you turn off the shortcut, add ?kameleoon=true to your URL. For example: https://www.website.com/?kameleoon=true.