Skip to main content

Get one site by code​

Get one site with given site code

Path Parameters
  • siteCode string required
Query Parameters
  • optionalFields string[]
Responses

OK

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[]

    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]

    Targeting criteria to be excluded from your recommendations

  • 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[]

    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]

    The 3 targeting criteria to be prioritized in your recommendations

  • mainGoal int64 required

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

  • siteType string

    Possible 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, KWD]

  • 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 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[]

    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 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

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

    Project type.

  • url string required

    URL of the website.

  • wideDomain string
  • widgetFonts object[]

    Widget fonts for site.

  • Array [
  • fontFamily string
  • fontSrc string
  • fontWeight string
  • id string
  • ]
Loading...