curl --request PATCH \
--url https://api.kameleoon.com/sites/{siteId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"behaviorWhenTimeout": "RUN",
"currency": "USD",
"customSelectors": [
"<string>"
],
"dataStorage": "STANDARD_COOKIE",
"description": "<string>",
"domainNames": [
"<string>"
],
"dynamicApplicationSupport": "DISABLED",
"enableSinglePageSupport": true,
"indicators": [
"RETENTION_RATE"
],
"isScriptActive": true,
"sdkBotFiltering": true,
"shadowDom": true,
"trackerExcludedIPRanges": [
"<string>"
],
"trackingScript": "<string>",
"url": "<string>",
"useSharpSymbolInUrl": true,
"widgetFonts": [
{
"fontFamily": "<string>",
"fontSrc": "<string>",
"fontWeights": [
"<string>"
],
"id": "<string>",
"importSrc": "<string>"
}
]
}
'{
"url": "<string>",
"abtestConsent": "OFF",
"applicationFileUrl": "<string>",
"audienceConfig": {
"mainGoal": 123,
"cartAmountGoal": 123,
"cartAmountValue": 123,
"dateCreated": "2023-11-07T05:31:56Z",
"excludedConfigurationUrlList": [
{
"matchType": "EXACT",
"url": "<string>"
}
],
"excludedCustomData": [
123
],
"excludedExperimentList": [
123
],
"excludedGoalList": [
123
],
"excludedPersonalizationList": [
123
],
"excludedTargetingSegmentList": [
123
],
"excludedTargetingTypeList": [
"PAGE_URL"
],
"id": 123,
"ignoreURLSettings": true,
"includedConfigurationUrlList": [
{
"matchType": "EXACT",
"url": "<string>"
}
],
"includedCustomData": [
123
],
"includedExperimentList": [
123
],
"includedPersonalizationList": [
123
],
"includedTargetingSegmentList": [
123
],
"includedTargetingTypeList": [
"PAGE_URL"
],
"siteType": "ECOMMERCE"
},
"behaviorWhenTimeout": "RUN",
"captureEventMethod": "CLICK",
"code": "<string>",
"currency": "USD",
"customAttributes": "<string>",
"customSelectors": [
"<string>"
],
"dataStorage": "STANDARD_COOKIE",
"dateCreated": "2023-11-07T05:31:56Z",
"description": "<string>",
"domainNames": [
"<string>"
],
"experimentConfig": {
"abtestConsent": "OFF",
"abtestConsentOptout": "RUN",
"beforeAbtestConsent": "NONE",
"customVariationSelectionScript": "<string>",
"isEditorLaunchedByShortcut": true,
"isKameleoonReportingEnabled": true,
"minWiningReliability": 123
},
"id": 123,
"imagesUrl": "<string>",
"indicators": [
"RETENTION_RATE"
],
"isAudienceUsed": true,
"isKameleoonEnabled": true,
"isScriptActive": true,
"kameleoonDomain": "<string>",
"lastScriptRebuildDate": "2023-11-07T05:31:56Z",
"lastScriptRebuildStatus": "SUCCESS",
"name": "<string>",
"personalizationConfig": {
"beforePersonalizationConsent": "NONE",
"isSameJqueryInjectionAllowed": true,
"isSameTypePersonalizationEnabled": true,
"personalizationConsent": "OFF",
"personalizationConsentOptout": "RUN",
"personalizationsDeviation": 123
},
"realTimeConfigUpdate": true,
"recommendationSecretKey": "<string>",
"recommendationStoreKey": "<string>",
"responsiveMobile": true,
"shadowDom": true,
"trackingScript": "<string>",
"type": "SITE",
"wideDomain": "<string>",
"widgetFonts": [
{
"fontFamily": "<string>",
"fontSrc": "<string>",
"fontWeights": [
"<string>"
],
"id": "<string>",
"importSrc": "<string>"
}
]
}Updates multiple fields of the site.
curl --request PATCH \
--url https://api.kameleoon.com/sites/{siteId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"behaviorWhenTimeout": "RUN",
"currency": "USD",
"customSelectors": [
"<string>"
],
"dataStorage": "STANDARD_COOKIE",
"description": "<string>",
"domainNames": [
"<string>"
],
"dynamicApplicationSupport": "DISABLED",
"enableSinglePageSupport": true,
"indicators": [
"RETENTION_RATE"
],
"isScriptActive": true,
"sdkBotFiltering": true,
"shadowDom": true,
"trackerExcludedIPRanges": [
"<string>"
],
"trackingScript": "<string>",
"url": "<string>",
"useSharpSymbolInUrl": true,
"widgetFonts": [
{
"fontFamily": "<string>",
"fontSrc": "<string>",
"fontWeights": [
"<string>"
],
"id": "<string>",
"importSrc": "<string>"
}
]
}
'{
"url": "<string>",
"abtestConsent": "OFF",
"applicationFileUrl": "<string>",
"audienceConfig": {
"mainGoal": 123,
"cartAmountGoal": 123,
"cartAmountValue": 123,
"dateCreated": "2023-11-07T05:31:56Z",
"excludedConfigurationUrlList": [
{
"matchType": "EXACT",
"url": "<string>"
}
],
"excludedCustomData": [
123
],
"excludedExperimentList": [
123
],
"excludedGoalList": [
123
],
"excludedPersonalizationList": [
123
],
"excludedTargetingSegmentList": [
123
],
"excludedTargetingTypeList": [
"PAGE_URL"
],
"id": 123,
"ignoreURLSettings": true,
"includedConfigurationUrlList": [
{
"matchType": "EXACT",
"url": "<string>"
}
],
"includedCustomData": [
123
],
"includedExperimentList": [
123
],
"includedPersonalizationList": [
123
],
"includedTargetingSegmentList": [
123
],
"includedTargetingTypeList": [
"PAGE_URL"
],
"siteType": "ECOMMERCE"
},
"behaviorWhenTimeout": "RUN",
"captureEventMethod": "CLICK",
"code": "<string>",
"currency": "USD",
"customAttributes": "<string>",
"customSelectors": [
"<string>"
],
"dataStorage": "STANDARD_COOKIE",
"dateCreated": "2023-11-07T05:31:56Z",
"description": "<string>",
"domainNames": [
"<string>"
],
"experimentConfig": {
"abtestConsent": "OFF",
"abtestConsentOptout": "RUN",
"beforeAbtestConsent": "NONE",
"customVariationSelectionScript": "<string>",
"isEditorLaunchedByShortcut": true,
"isKameleoonReportingEnabled": true,
"minWiningReliability": 123
},
"id": 123,
"imagesUrl": "<string>",
"indicators": [
"RETENTION_RATE"
],
"isAudienceUsed": true,
"isKameleoonEnabled": true,
"isScriptActive": true,
"kameleoonDomain": "<string>",
"lastScriptRebuildDate": "2023-11-07T05:31:56Z",
"lastScriptRebuildStatus": "SUCCESS",
"name": "<string>",
"personalizationConfig": {
"beforePersonalizationConsent": "NONE",
"isSameJqueryInjectionAllowed": true,
"isSameTypePersonalizationEnabled": true,
"personalizationConsent": "OFF",
"personalizationConsentOptout": "RUN",
"personalizationsDeviation": 123
},
"realTimeConfigUpdate": true,
"recommendationSecretKey": "<string>",
"recommendationStoreKey": "<string>",
"responsiveMobile": true,
"shadowDom": true,
"trackingScript": "<string>",
"type": "SITE",
"wideDomain": "<string>",
"widgetFonts": [
{
"fontFamily": "<string>",
"fontSrc": "<string>",
"fontWeights": [
"<string>"
],
"id": "<string>",
"importSrc": "<string>"
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.kameleoon.com/llms.txt
Use this file to discover all available pages before exploring further.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
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.
RUN, DISABLE_FOR_PAGE, DISABLE_FOR_VISIT Currency used in the website.
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 This option allows you to choose the source for storing A/B test data on the visitor’s device.
STANDARD_COOKIE, LOCAL_STORAGE, CUSTOM_COOKIE Website description
Dynamic application support. Modifiable only by a super admin.
DISABLED, ENABLED_FOR_SITE, ENABLED_FOR_ELEMENTS Deprecated. Use dynamicApplicationSupport instead.Single Page support. Modifiable only by a super admin.
List of indicators such as: Retention rate, number of pages seen and dwell time.
List of indicators such as: Retention rate, number of pages seen and dwell time.
RETENTION_RATE, NUMBER_OF_PAGES_SEEN, DWELL_TIME Indicates if the script has been successfully installed and is active on the website.
This will enable bot filtering for events sent from the SDK, by using the IAB/ABC International Spiders and Bots List.
ShadowDOM option.
Excluded IP ranges. Modifiable only by a super admin.
Excluded IP ranges. Modifiable only by a super admin.
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.
URL of the website
Use sharp symbol in url. Modifiable only by a super admin.
Widget fonts for site.
Show child attributes
OK
URL of the website.
OFF, REQUIRED, IABTCF URL for self-hosted kameleoon.js file. If not specified kameleoon.js will be loaded by default url - SITE_CODE.kameleoon.eu/kameleoon.js
Audience configuration.
Show child attributes
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.
RUN, DISABLE_FOR_PAGE, DISABLE_FOR_VISIT CLICK, MOUSEDOWN, MOUSEUP System generated code to uniquely identify a website.
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 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.
STANDARD_COOKIE, LOCAL_STORAGE, CUSTOM_COOKIE Date when the site was created.
Website description.
Configuration of an experiment.
Show child attributes
Unique Id of the website.
URL for self-hosted images. If not specified images will be loaded by default url - SITE_CODE.kameleoon.eu/images/
List of indicators such as: Retention rate, number of pages seen and dwell time.
List of indicators such as: Retention rate, number of pages seen and dwell time.
RETENTION_RATE, NUMBER_OF_PAGES_SEEN, DWELL_TIME Indicates if audience feature is enabled and used for the website.
Indicates if Kameleoon application is enbabled for the website.
Indicates if the script has been installed successfully and is active on the website.
Date last rebuild Script.
Status last rebuild Script.
SUCCESS, FAILURE Name of the website.
30Configuration of a personalization.
Show child attributes
Can SDK receive the configuration in real-time.
Product recommendation secret key.
Product recommendation store key.
ShadowDOM option.
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.
Project type.
SITE, SITE_JS, SITE_SDK, APPLICATION Deprecated, use kameleoonDomain instead
Widget fonts for site.
Show child attributes
Was this page helpful?