Skip to main content
GET
Get a site by code

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

siteCode
string
required

Query Parameters

optionalFields
string[]

Response

OK

url
string
required

URL of the website.

Available options:
OFF,
REQUIRED,
IABTCF
applicationFileUrl
string

URL for self-hosted kameleoon.js file. If the request omits the URL, Kameleoon loads kameleoon.js by default URL - SITE_CODE.kameleoon.eu/kameleoon.js

audienceConfig
object

Audience configuration.

behaviorWhenTimeout
enum<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, but with a flicker effect.

Available options:
RUN,
DISABLE_FOR_PAGE,
DISABLE_FOR_VISIT
captureEventMethod
enum<string>
Available options:
CLICK,
MOUSEDOWN,
MOUSEUP
code
string
read-only

System generated code to uniquely identify a website.

currency
enum<string>
Available options:
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
enum<string>

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

Available options:
STANDARD_COOKIE,
LOCAL_STORAGE,
CUSTOM_COOKIE
dateCreated
string<date-time>
read-only

Date of site creation.

description
string

Website description.

domainNames
string[]
experimentConfig
object

Configuration of an experiment.

id
integer<int64>
read-only

Unique ID of the website.

imagesUrl
string

URL for self-hosted images. If the request omits the URL, Kameleoon loads images by default URL - SITE_CODE.kameleoon.eu/images/

indicators
enum<string>[]

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

Available options:
RETENTION_RATE,
NUMBER_OF_PAGES_SEEN,
DWELL_TIME
isAudienceUsed
boolean

Indicates if the website enables and uses the audience feature.

isKameleoonEnabled
boolean

Indicates if the website enables the Kameleoon application.

isScriptActive
boolean

Indicates if a user installed the script successfully and the script is active on the website.

kameleoonDomain
string
lastScriptRebuildDate
string<date-time>

Date last rebuild Script.

lastScriptRebuildStatus
enum<string>

Status last rebuild Script.

Available options:
SUCCESS,
FAILURE
name
string

Name of the website.

Maximum string length: 30
personalizationConfig
object

Configuration of a personalization.

realTimeConfigUpdate
boolean

Can SDK receive the configuration in real-time.

recommendationSecretKey
string

Product recommendation secret key.

recommendationStoreKey
string

Product recommendation store key.

responsiveMobile
boolean
shadowDom
boolean

ShadowDOM option.

tags
string[]

List of tags associated with the website.

List of tags associated with the website.

trackingScript
string

Global custom script is any JavaScript code that you add which executes at each page load. This custom script executes 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
enum<string>

Project type.

Available options:
SITE,
SITE_JS,
SITE_SDK,
APPLICATION
wideDomain
string
deprecated

Deprecated, use kameleoonDomain instead

widgetFonts
object[]

Widget fonts for site.