Get all sites
Get list of all sites of the customer
Query Parameters
- paramsIO object required
- optionalFields string[]
- 200
- 400
- 403
- 500
- 503
OK
- */*
- Schema
- Example (from schema)
Schema
- Array [
- 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 int64Goal to which the value of customer's basket is linked
cartAmountValue int64Conversion value linked to the primary goal
dateCreated date-timeAudience configuration creation date
excludedConfigurationUrlList object[]
URLS to be excluded from your recommendations
Array [matchType stringPossible 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[]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
,CUSTOM
,SDK_LANGUAGE
,VISITOR_CODE
,EXCLUSIVE_FEATURE_FLAG
,TARGET_FEATURE_FLAG
,APPLICATION_VERSION
]Targeting criteria to be excluded from your recommendations
id int64The unique identifier for the audience configuration
ignoreURLSettings booleanIgnore the settings in the URL of your pages
includedConfigurationUrlList object[]
URLs you want to optimize primarily
Array [matchType stringPossible values: [
EXACT
,CONTAINS
,REGULAR_EXPRESSION
,TARGETED_URL
]url string]includedCustomData int64[]Personalized data to be treated primarily in your recommendations
includedExperimentList int64[]A/B tests to be privileged in your recommendations
includedPersonalizationList int64[]Personalizations to be privileged in your recommendations
includedTargetingSegmentList int64[]Additional segments to track. Predictive segments are tracked by default
includedTargetingTypeList string[]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
,CUSTOM
,SDK_LANGUAGE
,VISITOR_CODE
,EXCLUSIVE_FEATURE_FLAG
,TARGET_FEATURE_FLAG
,APPLICATION_VERSION
]The 3 targeting criteria to be treated primarily in your recommendations
mainGoal int64 requiredPrimary goal, it must correspond to the main conversion action of the site
siteType stringPossible values: [
ECOMMERCE
,MEDIA
,OTHER
]Typology of the website
- behaviorWhenTimeout string
Possible values: [
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 with a flicker effect.
- captureEventMethod string
Possible values: [
CLICK
,MOUSEDOWN
,MOUSEUP
] - code string
System generated code to uniquely identify a website.
- currency string
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
] - customAttributes string
- customSelectors string[]
- dataStorage string
Possible values: [
STANDARD_COOKIE
,LOCAL_STORAGE
,CUSTOM_COOKIE
]This option allows you to choose source where to store the data of your A/B tests on the the visitor's device
- dateCreated date-time
Date when the site was created.
- description string
Website description
- domainNames string[]
experimentConfig object
Configuration of an experiment
abtestConsent stringPossible values: [
OFF
,REQUIRED
,IABTCF
]abtestConsentOptout stringPossible values: [
RUN
,BLOCK
]beforeAbtestConsent stringPossible values: [
NONE
,PARTIALLY
,ALL
]customVariationSelectionScript stringVariation selection script. By default, the assignation of an experiment's variation to a visitor is done via a random mechanism. You can write a JavaScript code here to customize this behavior. The code must return the id of the assigned variation (consult the documentation for details).
isEditorLaunchedByShortcut booleanEditor launching. Enable launching the editor via Shift + F2
isKameleoonReportingEnabled booleanResult reporting. Activate Kameleoon’s reporting to view test results
minWiningReliability int32Necessary reliability for the determination of a winning variation. The reliability of the variations is inferior to the rate determined in set-up. The variations cannot be considered as winning in your test results, whatever the number of conversions of these variations. Please be parcimonious about changing this parameter, as this has an impact on the results Kameleoon delivers.
gathererConfiguration object
Gatherer сonfiguration
browsers object[]
Array [browserIndex int32dateCreated date-timedateModified date-timeid int64name string]customDatas object[]
Array [advancedProposedValues stringcreatedById int64customEvalCode stringdateCreated date-timedateModified date-timedescription stringformat stringPossible values: [
NUMBER
,STRING
,BOOLEAN
]gtmVariableName stringid int64index int32isConstant booleanisDeleted booleanisDependant booleanisFiltrableVentilable booleanisLearnable booleanisLocalOnly booleanisMappingIdentifier booleanisTargetable booleanmethod stringPossible values: [
CLIENT
,CUSTOM_CODE
,GTM
,TC
,SDK
,TEALIUM
]name stringnumberValues int32 deprecatedscope stringPossible values: [
PAGE
,VISIT
,VISITOR
]siteId int64tags string[]tcVariableName stringtealiumVariableName stringtype stringPossible values: [
COUNT_LIST
,LIST
,UNIQUE
,BOOLEAN
,STRING
,NUMBER
]]directNoneReferrerOnlyFirst booleanforceNoTrack booleanid int64keyPages object[]
Array [createdById int64dateCreated date-timedateModified date-timedescription stringid int64index int32isDeleted booleanmatchType stringname stringpreciseDate date-timerelativeUrlRegExp stringsecondMatchType stringsiteId int64totalCount int32]keyWords object[]
Array [dateCreated date-timedateModified date-timeid int64index int32isDeleted booleanname stringsiteId int64wordRegExp string]languages object[]
Array [code stringid int64index int32siteId int64]noReferrerPages stringoss object[]
Array [disabled booleanid int64index int32name stringsiteId int64]referrers object[]
Array [createdById int64dateCreated date-timedateModified date-timedescription stringdetections object[]
Array [and booleanandMethod stringandParameters stringmethod stringparameters string]id int64index int32isDeleted booleanname stringpriority int32siteId int64tags string]timeZoneGroups object[]
Array [dateCreated date-timedateModified date-timeid int64timeZoneGroupIndex int32timeZones string[]]- id int64
The unique identifier for 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[]
Possible values: [
RETENTION_RATE
,NUMBER_OF_PAGES_SEEN
,DWELL_TIME
]List of indicators such as: Retention rate, number of pages seen and 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
- lastScriptRebuildDate date-time
Date last rebuild Script
- lastScriptRebuildStatus string
Possible values: [
SUCCESS
,FAILURE
]Status last rebuild Script
- name string
Possible values:
<= 30 characters
Name of the website
personalizationConfig object
Configuration of a personalization
beforePersonalizationConsent stringPossible values: [
NONE
,PARTIALLY
,ALL
]isSameJqueryInjectionAllowed booleanAllow the injection of jQuery. By default, Kameleoon allows you to display several personalization of the same kind on the same page (for example: 2 pop-ins or 2 images at the same place). If you want to disable this behavior, please switch on the following toggle.
isSameTypePersonalizationEnabled booleanAdvanced options. By default, Kameleoon allows you to display several personalization of the same kind on the same page (for example: 2 pop-ins or 2 images at the same place). If you want to disable this behavior, please switch on the following toggle.
personalizationConsent stringPossible values: [
OFF
,REQUIRED
,IABTCF
]personalizationConsentOptout stringPossible values: [
RUN
,BLOCK
]personalizationsDeviation doubleInclude visitors. Percentage of your visitors included to personalizations. You can define a visitor rate who will never be exposed to your personalizations. We advise youto keep a sample population, not exposed, in order to determine the efficiency 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
Possible values: [
SITE
,SITE_JS
,SITE_SDK
,APPLICATION
]Project type
- url string required
URL of the website
widgetFonts object[]
Widget fonts for site
Array [fontFamily stringfontSrc stringfontWeight stringid string]- ]
[
{
"abtestConsent": "OFF",
"applicationFileUrl": "string",
"audienceConfig": {
"cartAmountGoal": 0,
"cartAmountValue": 0,
"dateCreated": "2024-03-29T01:36:43.091Z",
"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-03-29T01:36:43.091Z",
"description": "string",
"domainNames": [
"string"
],
"experimentConfig": {
"abtestConsent": "OFF",
"abtestConsentOptout": "RUN",
"beforeAbtestConsent": "NONE",
"customVariationSelectionScript": "string",
"isEditorLaunchedByShortcut": true,
"isKameleoonReportingEnabled": true,
"minWiningReliability": 0
},
"gathererConfiguration": {
"browsers": [
{
"browserIndex": 0,
"dateCreated": "2024-03-29T01:36:43.091Z",
"dateModified": "2024-03-29T01:36:43.091Z",
"id": 0,
"name": "string"
}
],
"customDatas": [
{
"advancedProposedValues": "string",
"createdById": 0,
"customEvalCode": "string",
"dateCreated": "2024-03-29T01:36:43.091Z",
"dateModified": "2024-03-29T01:36:43.091Z",
"description": "string",
"format": "NUMBER",
"gtmVariableName": "string",
"id": 0,
"index": 0,
"isConstant": true,
"isDeleted": true,
"isDependant": true,
"isFiltrableVentilable": true,
"isLearnable": true,
"isLocalOnly": true,
"isMappingIdentifier": true,
"isTargetable": true,
"method": "CLIENT",
"name": "string",
"scope": "PAGE",
"siteId": 0,
"tags": [
"string"
],
"tcVariableName": "string",
"tealiumVariableName": "string",
"type": "COUNT_LIST"
}
],
"directNoneReferrerOnlyFirst": true,
"forceNoTrack": true,
"id": 0,
"keyPages": [
{
"createdById": 0,
"dateCreated": "2024-03-29T01:36:43.091Z",
"dateModified": "2024-03-29T01:36:43.091Z",
"description": "string",
"id": 0,
"index": 0,
"isDeleted": true,
"matchType": "string",
"name": "string",
"preciseDate": "2024-03-29T01:36:43.091Z",
"relativeUrlRegExp": "string",
"secondMatchType": "string",
"siteId": 0,
"totalCount": 0
}
],
"keyWords": [
{
"dateCreated": "2024-03-29T01:36:43.091Z",
"dateModified": "2024-03-29T01:36:43.091Z",
"id": 0,
"index": 0,
"isDeleted": true,
"name": "string",
"siteId": 0,
"wordRegExp": "string"
}
],
"languages": [
{
"code": "string",
"id": 0,
"index": 0,
"siteId": 0
}
],
"noReferrerPages": "string",
"oss": [
{
"disabled": true,
"id": 0,
"index": 0,
"name": "string",
"siteId": 0
}
],
"referrers": [
{
"createdById": 0,
"dateCreated": "2024-03-29T01:36:43.091Z",
"dateModified": "2024-03-29T01:36:43.091Z",
"description": "string",
"detections": [
{
"and": true,
"andMethod": "string",
"andParameters": "string",
"method": "string",
"parameters": "string"
}
],
"id": 0,
"index": 0,
"isDeleted": true,
"name": "string",
"priority": 0,
"siteId": 0,
"tags": "string"
}
],
"timeZoneGroups": [
{
"dateCreated": "2024-03-29T01:36:43.091Z",
"dateModified": "2024-03-29T01:36:43.091Z",
"id": 0,
"timeZoneGroupIndex": 0,
"timeZones": [
"string"
]
}
]
},
"id": 0,
"imagesUrl": "string",
"indicators": [
"RETENTION_RATE"
],
"isAudienceUsed": true,
"isKameleoonEnabled": true,
"isScriptActive": true,
"lastScriptRebuildDate": "2024-03-29T01:36:43.091Z",
"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",
"fontWeight": "string",
"id": "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-03-29T01:36:43.092Z"
}
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-03-29T01:36:43.092Z"
}
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-03-29T01:36:43.092Z"
}
Service Unavailable
- */*
- Schema
- Example (from schema)
Schema
- object
{}