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

PATCH /sites/:siteId

Update several fields of site

Request

Path Parameters

siteId int64required

application/json

Body

required

behaviorWhenTimeout string

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.

Possible values: [RUN, DISABLE_FOR_PAGE, DISABLE_FOR_VISIT]

currency string

Currency used in the website.

Possible values: [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]

customSelectors string[]

dataStorage string

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

Possible values: [STANDARD_COOKIE, LOCAL_STORAGE, CUSTOM_COOKIE]

description string

Website description

domainNames string[]

dynamicApplicationSupport string

Dynamic application support. Modifiable only by a super admin.

Possible values: [DISABLED, ENABLED_FOR_SITE, ENABLED_FOR_ELEMENTS]

enableSinglePageSupport booleandeprecated

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

indicators string[]

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

Possible values: [RETENTION_RATE, NUMBER_OF_PAGES_SEEN, DWELL_TIME]

isScriptActive boolean

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

sdkBotFiltering boolean

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

shadowDom boolean

ShadowDOM option.

trackerExcludedIPRanges string[]

Excluded IP ranges. Modifiable only by a super admin.

trackingScript string

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 string

URL of the website

useSharpSymbolInUrl boolean

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

widgetFonts

object[]

Widget fonts for site.

Array [

fontFamily string

fontSrc string

fontWeights string[]

id string

importSrc string

]

Responses

Schema
Example (from schema)

Schema

abtestConsent string

Possible values: [OFF, REQUIRED, IABTCF]

applicationFileUrl string

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

audienceConfig

object

Audience configuration.

cartAmountGoal int64

Goal to which the value of a customer's basket is linked

cartAmountValue int64

Conversion value linked to the primary goal

dateCreated date-time

Audience configuration creation date

excludedConfigurationUrlList

object[]

URLS to be excluded from your recommendations

Array [

matchType string

Possible values: [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]

url string

]

excludedCustomData int64[]

Personalized data to be excluded from your recommendations

excludedExperimentList int64[]

A/B tests to be excluded from your recommendations

excludedGoalList int64[]

Goals to be excluded from your recommendations

excludedPersonalizationList int64[]

Personalizations to be excluded from your recommendations

excludedTargetingSegmentList int64[]

Segments to be excluded from your recommendations

excludedTargetingTypeList string[]

Targeting criteria to be excluded from your recommendations

Possible values: [PAGE_URL, PAGE_TITLE, LANDING_PAGE, ORIGIN, ORIGIN_TYPE, REFERRERS, NEW_VISITORS, BROWSER_LANGUAGE, GEOLOCATION, DEVICE_TYPE, SCREEN_DIMENSION, VISITOR_IP, AD_BLOCKER, PREVIOUS_PAGE, KEY_PAGES, PAGE_VIEWS, FIRST_VISIT, LAST_VISIT, ACTIVE_SESSION, TIME_SINCE_PAGE_LOAD, SAME_DAY_VISITS, VISITS, VISITS_BY_PAGE, INTERNAL_SEARCH_KEYWORDS, TABS_ON_SITE, HEAT_SLICE, SKY_STATUS, TEMPERATURE, DAY_NIGHT, FORECAST_SKY_STATUS, FORECAST_TEMPERATURE, DAY_OF_WEEK, TIME_RANGE, HOUR_MINUTE_RANGE, JS_CODE, COOKIE, EVENT, EXPLICIT_TRIGGER, BROWSER, OPERATING_SYSTEM, DOM_ELEMENT, MOUSE_OUT, TARGET_EXPERIMENT, TARGET_PERSONALIZATION, EXCLUSIVE_EXPERIMENT, CONVERSIONS, CUSTOM_DATUM, YSANCE_SEGMENT, YSANCE_ATTRIBUT, TEALIUM_BADGE, TEALIUM_AUDIENCE, PRICE_OF_DISPLAYED_PAGE, NUMBER_OF_VISITED_PAGES, VISITED_PAGES, SEGMENT, KEY_MOMENT, CUSTOM, SDK_LANGUAGE, VISITOR_CODE, EXCLUSIVE_FEATURE_FLAG, TARGET_FEATURE_FLAG, APPLICATION_VERSION]

id int64

Unique identifier of the audience configuration

ignoreURLSettings boolean

Ignore the settings in the URL of your pages

includedConfigurationUrlList

object[]

Primary URLs you want to optimize

Array [

matchType string

Possible values: [EXACT, CONTAINS, REGULAR_EXPRESSION, TARGETED_URL]

url string

]

includedCustomData int64[]

Personalized data to be prioritized in your recommendations

includedExperimentList int64[]

A/B tests to be prioritized in your recommendations

includedPersonalizationList int64[]

Personalizations to be prioritized in your recommendations

includedTargetingSegmentList int64[]

Additional segments to track. Predictive segments are tracked by default

includedTargetingTypeList string[]

The 3 targeting criteria to be prioritized in your recommendations

mainGoal int64required

Primary goal, it must correspond to the main conversion action of the site

siteType string

Typology of the website

Possible values: [ECOMMERCE, MEDIA, OTHER]

behaviorWhenTimeout string

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 with a flicker effect.

Possible values: [RUN, DISABLE_FOR_PAGE, DISABLE_FOR_VISIT]

captureEventMethod string

Possible values: [CLICK, MOUSEDOWN, MOUSEUP]

code string

System generated code to uniquely identify a website.

currency string

customAttributes string

customSelectors string[]

dataStorage string

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

Possible values: [STANDARD_COOKIE, LOCAL_STORAGE, CUSTOM_COOKIE]

dateCreated date-time

Date when the site was created.

description string

Website description.

domainNames string[]

experimentConfig

object

Configuration of an experiment.

abtestConsent string

Possible values: [OFF, REQUIRED, IABTCF]

abtestConsentOptout string

Possible values: [RUN, BLOCK]

beforeAbtestConsent string

Possible values: [NONE, PARTIALLY, ALL]

customVariationSelectionScript string

Variation Selection Script: By default, the assignment of a variation for an experiment to a visitor is handled through a random mechanism.You can customize this behavior by writing JavaScript code here. This code must return the ID of the assigned variation (please consult the developer documentation for more details).

isEditorLaunchedByShortcut boolean

Enables graphic editor launching through shift + F2 keyboard shortcut.

isKameleoonReportingEnabled boolean

Result reporting. Activate Kameleoon’s reporting to view test results

minWiningReliability int32

Level of reliability needed to determine the winning variation of an experiment. Reliabilityof the variations is inferior to the rate determined in set-up. The variations should not be consideredas winning in your test results, regardless of the number of conversions for these variations. Be cautiouswhen changing this parameter, as it impacts the results Kameleoon provides.

id int64

Unique identifier of the website.

imagesUrl string

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

indicators string[]

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

Possible values: [RETENTION_RATE, NUMBER_OF_PAGES_SEEN, DWELL_TIME]

isAudienceUsed boolean

Identifies where audience feature is enabled and used for the website.

isKameleoonEnabled boolean

This field represents if Kameleoon application is enbabled for the website.

isScriptActive boolean

Identifies if the script is installed successfully and is active on the website.

kameleoonDomain string

lastScriptRebuildDate date-time

Date last rebuild Script.

lastScriptRebuildStatus string

Status last rebuild Script.

Possible values: [SUCCESS, FAILURE]

name string

Name of the website.

Possible values: <= 30 characters

personalizationConfig

object

Configuration of a personalization.

beforePersonalizationConsent string

Possible values: [NONE, PARTIALLY, ALL]

isSameJqueryInjectionAllowed boolean

Allow the injection of jQuery. By default, Kameleoon allows you to display multiplepersonalization of the same type on a single page (for example, two pop-ups or two images in the same location).If you would like to disable this feature, please turn on the toggle option.

isSameTypePersonalizationEnabled boolean

Advanced options. By default, Kameleoon allows you to display multiplepersonalization of the same type on a single page (for example, two pop-ups or two images in the same location).If you would like to disable this feature, please turn on the toggle option.

personalizationConsent string

Possible values: [OFF, REQUIRED, IABTCF]

personalizationConsentOptout string

Possible values: [RUN, BLOCK]

personalizationsDeviation double

Include visitors. Percentage of your visitors included in personalizations.You can define a visitor rate who will be hidden to your personalizations.Additionally, we advise you to keep a hidden sample population to determine theefficiency of your personalizations.

realTimeConfigUpdate boolean

Can SDK receive the configuration in real-time.

recommendationSecretKey string

Product recommendation secret key.

recommendationStoreKey string

Product recommendation store key.

shadowDom boolean

ShadowDOM option.

trackingScript string

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 string

Project type.

Possible values: [SITE, SITE_JS, SITE_SDK, APPLICATION]

url stringrequired

URL of the website.

wideDomain stringdeprecated

Deprecated, use kameleoonDomain instead

widgetFonts

object[]

Widget fonts for site.

Array [

fontFamily string

fontSrc string

fontWeights string[]

id string

importSrc string

]

{
  "abtestConsent": "OFF",
  "applicationFileUrl": "string",
  "audienceConfig": {
    "cartAmountGoal": 0,
    "cartAmountValue": 0,
    "dateCreated": "2024-07-29T15:51:28.071Z",
    "excludedConfigurationUrlList": [
      {
        "matchType": "EXACT",
        "url": "string"
      }
    ],
    "excludedCustomData": [
      0
    ],
    "excludedExperimentList": [
      0
    ],
    "excludedGoalList": [
      0
    ],
    "excludedPersonalizationList": [
      0
    ],
    "excludedTargetingSegmentList": [
      0
    ],
    "excludedTargetingTypeList": [
      "PAGE_URL"
    ],
    "id": 0,
    "ignoreURLSettings": true,
    "includedConfigurationUrlList": [
      {
        "matchType": "EXACT",
        "url": "string"
      }
    ],
    "includedCustomData": [
      0
    ],
    "includedExperimentList": [
      0
    ],
    "includedPersonalizationList": [
      0
    ],
    "includedTargetingSegmentList": [
      0
    ],
    "includedTargetingTypeList": [
      "PAGE_URL"
    ],
    "mainGoal": 0,
    "siteType": "ECOMMERCE"
  },
  "behaviorWhenTimeout": "RUN",
  "captureEventMethod": "CLICK",
  "code": "string",
  "currency": "USD",
  "customAttributes": "string",
  "customSelectors": [
    "string"
  ],
  "dataStorage": "STANDARD_COOKIE",
  "dateCreated": "2024-07-29T15:51:28.071Z",
  "description": "string",
  "domainNames": [
    "string"
  ],
  "experimentConfig": {
    "abtestConsent": "OFF",
    "abtestConsentOptout": "RUN",
    "beforeAbtestConsent": "NONE",
    "customVariationSelectionScript": "string",
    "isEditorLaunchedByShortcut": true,
    "isKameleoonReportingEnabled": true,
    "minWiningReliability": 0
  },
  "id": 0,
  "imagesUrl": "string",
  "indicators": [
    "RETENTION_RATE"
  ],
  "isAudienceUsed": true,
  "isKameleoonEnabled": true,
  "isScriptActive": true,
  "kameleoonDomain": "string",
  "lastScriptRebuildDate": "2024-07-29T15:51:28.071Z",
  "lastScriptRebuildStatus": "SUCCESS",
  "name": "string",
  "personalizationConfig": {
    "beforePersonalizationConsent": "NONE",
    "isSameJqueryInjectionAllowed": true,
    "isSameTypePersonalizationEnabled": true,
    "personalizationConsent": "OFF",
    "personalizationConsentOptout": "RUN",
    "personalizationsDeviation": 0
  },
  "realTimeConfigUpdate": true,
  "recommendationSecretKey": "string",
  "recommendationStoreKey": "string",
  "shadowDom": true,
  "trackingScript": "string",
  "type": "SITE",
  "url": "string",
  "widgetFonts": [
    {
      "fontFamily": "string",
      "fontSrc": "string",
      "fontWeights": [
        "string"
      ],
      "id": "string",
      "importSrc": "string"
    }
  ]
}

Bad Request

Schema
Example (from schema)

Schema

code string

impersonator string

message string

name string

status string

Possible values: [SUCCESS, ERROR]

sub string

time int64

timestamp date-time

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

Forbidden

Schema
Example (from schema)

Schema

code string

impersonator string

message string

name string

status string

Possible values: [SUCCESS, ERROR]

sub string

time int64

timestamp date-time

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

Locked

Schema
Example (from schema)

Schema

code string

impersonator string

message string

name string

status string

Possible values: [SUCCESS, ERROR]

sub string

time int64

timestamp date-time

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

Internal Server Error

Schema
Example (from schema)

Schema

code string

impersonator string

message string

name string

status string

Possible values: [SUCCESS, ERROR]

sub string

time int64

timestamp date-time

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

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

/sites/:siteId

Request​

Path Parameters

Body

Responses​

Request

Responses