KAkameleoon
Site

Partially update site, when only information that is passed is updated

Update several fields of site

patch/sites/{siteId}

Request

Path parameters

siteIdinteger required

Request body

behaviorWhenTimeout'RUN' | 'DISABLE_FOR_PAGE' | 'DISABLE_FOR_VISIT'

When a timeout occurs, you can redefine the behavior of Kameleoon Application if the script exceeds the usual loading time.By default, the application will eventually launch with a flickering effect.

currency'USD' | 'EUR' | 'JPY' | 'GBP' | 'CNY' | 'AUD' | 'CAD' | 'CHF' | 'HKD' | 'SGD' | 'SEK' | 'KRW' | 'NOK' | 'NZD' | 'INR' | 'MXN' | 'TWD' | 'ZAR' | 'BRL' | 'DKK' | 'PLN' | 'THB' | 'ILS' | 'IDR' | 'CZK' | 'AED' | 'TRY' | 'HUF' | 'CLP' | 'SAR' | 'PHP' | 'MYR' | 'COP' | 'RUB' | 'RON' | 'PEN' | 'BHD' | 'BGN' | 'ARS' | 'KWD'

Currency used in the website.

customSelectorsstring[]
dataStorage'STANDARD_COOKIE' | 'LOCAL_STORAGE' | 'CUSTOM_COOKIE'

This option allows you to choose the source for storing A/B test data on the visitor’s device.

descriptionstring

Website description

domainNamesstring[]
dynamicApplicationSupport'DISABLED' | 'ENABLED_FOR_SITE' | 'ENABLED_FOR_ELEMENTS'

Dynamic application support. Modifiable only by a super admin.

enableSinglePageSupportboolean

Deprecated. Use dynamicApplicationSupport instead.Single Page support. Modifiable only by a super admin.

indicatorsstring[]

List of indicators such as: Retention rate, number of pages seen and dwell time.

isScriptActiveboolean

Indicates if the script has been successfully installed and is active on the website.

sdkBotFilteringboolean

This will enable bot filtering for events sent from the SDK, by using the IAB/ABC International Spiders and Bots List.

shadowDomboolean

ShadowDOM option.

trackerExcludedIPRangesstring[]

Excluded IP ranges. Modifiable only by a super admin.

trackingScriptstring

A global custom script for example, a complex tracking code or integration to some third party solution) is any executable JavaScript code that you addwhen loading each page. This script will be executed right after the Kameleoon application loads.

urlstring

URL of the website

useSharpSymbolInUrlboolean

Use sharp symbol in url. Modifiable only by a super admin.

Response

OK

abtestConsent'OFF' | 'REQUIRED' | 'IABTCF'
applicationFileUrlstring

URL for self-hosted kameleoon.js file. If not specified kameleoon.js will be loaded by default url - SITE_CODE.kameleoon.eu/kameleoon.js

behaviorWhenTimeout'RUN' | 'DISABLE_FOR_PAGE' | 'DISABLE_FOR_VISIT'

Behavior if timeout occurs. You can redefine the behavior of Kameleoon Application when the script exceeds the usual loading time. By default, the application will eventually launch, but with a flicker effect.

captureEventMethod'CLICK' | 'MOUSEDOWN' | 'MOUSEUP'
codestring

System generated code to uniquely identify a website.

currency'USD' | 'EUR' | 'JPY' | 'GBP' | 'CNY' | 'AUD' | 'CAD' | 'CHF' | 'HKD' | 'SGD' | 'SEK' | 'KRW' | 'NOK' | 'NZD' | 'INR' | 'MXN' | 'TWD' | 'ZAR' | 'BRL' | 'DKK' | 'PLN' | 'THB' | 'ILS' | 'IDR' | 'CZK' | 'AED' | 'TRY' | 'HUF' | 'CLP' | 'SAR' | 'PHP' | 'MYR' | 'COP' | 'RUB' | 'RON' | 'PEN' | 'BHD' | 'BGN' | 'ARS' | 'KWD'
customAttributesstring
customSelectorsstring[]
dataStorage'STANDARD_COOKIE' | 'LOCAL_STORAGE' | 'CUSTOM_COOKIE'

This option allows you to choose the source where you can store the data of your A/B tests on the the visitor's device.

dateCreatedstring date-time

Date when the site was created.

descriptionstring

Website description.

domainNamesstring[]
idinteger

Unique Id of the website.

imagesUrlstring

URL for self-hosted images. If not specified images will be loaded by default url - SITE_CODE.kameleoon.eu/images/

indicatorsstring[]

List of indicators such as: Retention rate, number of pages seen and dwell time.

isAudienceUsedboolean

Indicates if audience feature is enabled and used for the website.

isKameleoonEnabledboolean

Indicates if Kameleoon application is enbabled for the website.

isScriptActiveboolean

Indicates if the script has been installed successfully and is active on the website.

kameleoonDomainstring
lastScriptRebuildDatestring date-time

Date last rebuild Script.

lastScriptRebuildStatus'SUCCESS' | 'FAILURE'

Status last rebuild Script.

namestring

Name of the website.

realTimeConfigUpdateboolean

Can SDK receive the configuration in real-time.

recommendationSecretKeystring

Product recommendation secret key.

recommendationStoreKeystring

Product recommendation store key.

responsiveMobileboolean
shadowDomboolean

ShadowDOM option.

trackingScriptstring

Global custom script is any JavaScript code that you add which will be executed at each page load. This custom script will be executed right after the loading of Kameleoon application. For instance, you can add complex tracking code or integration to some third party solutions in this section.

type'SITE' | 'SITE_JS' | 'SITE_SDK' | 'APPLICATION'

Project type.

urlstring required

URL of the website.

wideDomainstring

Deprecated, use kameleoonDomain instead

Changes

No recorded changes to this operation across all 1 revision of this API.