Create new site
POST/sites
Create new site with given parameters
Request
- application/json
Body
required
Array [
]
Array [
]
Array [
]
Possible values: [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
audienceConfig
object
Audience configuration.
Goal to which the value of a customer's basket is linked
Conversion value linked to the primary goal
Audience configuration creation date
excludedConfigurationUrlList
object[]
URLS to be excluded from your recommendations
Possible values: [EXACT
, CONTAINS
, REGULAR_EXPRESSION
, TARGETED_URL
]
Personalized data to be excluded from your recommendations
A/B tests to be excluded from your recommendations
Goals to be excluded from your recommendations
Personalizations to be excluded from your recommendations
Segments to be excluded from your recommendations
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
]
Ignore the settings in the URL of your pages
includedConfigurationUrlList
object[]
Primary URLs you want to optimize
Possible values: [EXACT
, CONTAINS
, REGULAR_EXPRESSION
, TARGETED_URL
]
Personalized data to be prioritized in your recommendations
A/B tests to be prioritized in your recommendations
Personalizations to be prioritized in your recommendations
Additional segments to track. Predictive segments are tracked by default
The 3 targeting criteria to be prioritized in 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
]
Primary goal, it must correspond to the main conversion action of the site
Typology of the website
Possible values: [ECOMMERCE
, MEDIA
, OTHER
]
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
]
Possible values: [CLICK
, MOUSEDOWN
, MOUSEUP
]
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
]
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
]
Website description.
experimentConfig
object
Configuration of an experiment.
Possible values: [OFF
, REQUIRED
, IABTCF
]
Possible values: [RUN
, BLOCK
]
Possible values: [NONE
, PARTIALLY
, ALL
]
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).
Enables graphic editor launching through shift + F2
keyboard shortcut.
Result reporting. Activate Kameleoon’s reporting to view test results
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.
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.
Possible values: [RETENTION_RATE
, NUMBER_OF_PAGES_SEEN
, DWELL_TIME
]
Identifies where audience feature is enabled and used for the website.
This field represents if Kameleoon application is enbabled for the website.
Identifies if the script is installed successfully and is active on the website.
Date last rebuild Script.
Status last rebuild Script.
Possible values: [SUCCESS
, FAILURE
]
Name of the website.
Possible values: <= 30 characters
personalizationConfig
object
Configuration of a personalization.
Possible values: [NONE
, PARTIALLY
, ALL
]
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.
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.
Possible values: [OFF
, REQUIRED
, IABTCF
]
Possible values: [RUN
, BLOCK
]
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.
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.
Possible values: [SITE
, SITE_JS
, SITE_SDK
, APPLICATION
]
URL of the website.
Deprecated, use kameleoonDomain instead
widgetFonts
object[]
Widget fonts for site.
Responses
- 201
- 400
- 403
- 423
- 500
Created
- */*
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Array [
]
Possible values: [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
audienceConfig
object
Audience configuration.
Goal to which the value of a customer's basket is linked
Conversion value linked to the primary goal
Audience configuration creation date
excludedConfigurationUrlList
object[]
URLS to be excluded from your recommendations
Possible values: [EXACT
, CONTAINS
, REGULAR_EXPRESSION
, TARGETED_URL
]
Personalized data to be excluded from your recommendations
A/B tests to be excluded from your recommendations
Goals to be excluded from your recommendations
Personalizations to be excluded from your recommendations
Segments to be excluded from your recommendations
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
]
Unique identifier of the audience configuration
Ignore the settings in the URL of your pages
includedConfigurationUrlList
object[]
Primary URLs you want to optimize
Possible values: [EXACT
, CONTAINS
, REGULAR_EXPRESSION
, TARGETED_URL
]
Personalized data to be prioritized in your recommendations
A/B tests to be prioritized in your recommendations
Personalizations to be prioritized in your recommendations
Additional segments to track. Predictive segments are tracked by default
The 3 targeting criteria to be prioritized in 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
]
Primary goal, it must correspond to the main conversion action of the site
Typology of the website
Possible values: [ECOMMERCE
, MEDIA
, OTHER
]
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
]
Possible values: [CLICK
, MOUSEDOWN
, MOUSEUP
]
System generated code to uniquely identify a 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
]
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
]
Date when the site was created.
Website description.
experimentConfig
object
Configuration of an experiment.
Possible values: [OFF
, REQUIRED
, IABTCF
]
Possible values: [RUN
, BLOCK
]
Possible values: [NONE
, PARTIALLY
, ALL
]
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).
Enables graphic editor launching through shift + F2
keyboard shortcut.
Result reporting. Activate Kameleoon’s reporting to view test results
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.
Unique identifier 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.
Possible values: [RETENTION_RATE
, NUMBER_OF_PAGES_SEEN
, DWELL_TIME
]
Identifies where audience feature is enabled and used for the website.
This field represents if Kameleoon application is enbabled for the website.
Identifies if the script is installed successfully and is active on the website.
Date last rebuild Script.
Status last rebuild Script.
Possible values: [SUCCESS
, FAILURE
]
Name of the website.
Possible values: <= 30 characters
personalizationConfig
object
Configuration of a personalization.
Possible values: [NONE
, PARTIALLY
, ALL
]
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.
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.
Possible values: [OFF
, REQUIRED
, IABTCF
]
Possible values: [RUN
, BLOCK
]
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.
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.
Possible values: [SITE
, SITE_JS
, SITE_SDK
, APPLICATION
]
URL of the website.
Deprecated, use kameleoonDomain instead
widgetFonts
object[]
Widget fonts for site.
{
"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
Possible values: [SUCCESS
, ERROR
]
{
"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
Possible values: [SUCCESS
, ERROR
]
{
"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
Possible values: [SUCCESS
, ERROR
]
{
"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
Possible values: [SUCCESS
, ERROR
]
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-07-29T15:51:28.071Z"
}