Get all variations - Kameleoon Documentation

GET

variations

Get all variations

curl --request GET \
  --url https://api.kameleoon.com/variations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kameleoon.com/variations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kameleoon.com/variations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kameleoon.com/variations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.kameleoon.com/variations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "name": "<string>",
    "siteId": 123,
    "color": 123,
    "creationMode": "AI",
    "cssCode": "<string>",
    "customJson": "<string>",
    "experimentId": 123,
    "expositionFrequencyDelaySecondsBetweenTwoExpositions": 123,
    "expositionFrequencySameVisit": 123,
    "expositionFrequencySameVisitor": 123,
    "expositionFrequencySameVisitorDelaySeconds": 123,
    "forceNoFlicker": true,
    "id": 123,
    "isJsCodeAfterDomReady": true,
    "jsCode": "<string>",
    "personalizationId": 123,
    "prompt": {
      "textInput": "<string>",
      "attachments": [
        {
          "mediaType": "IMAGE",
          "name": "US-39613 Image attachment",
          "type": "TEMPORARY"
        }
      ],
      "promptSource": "<string>"
    },
    "redirection": {
      "includeQueryParameters": true,
      "parameters": "param1=foo&param2=bar",
      "type": "GLOBAL_REDIRECTION",
      "url": "www.kameleoon.com"
    },
    "redirectionStrings": "<string>",
    "shadowDom": true,
    "widgetTemplateInput": "<string>"
  }
]

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

paramsIO

object

required

Show child attributes

Response

name

string

required

Name of the variation

siteId

integer<int64>

required

Site ID of the project the variation belongs to

color

integer<int32>

Variation color displayed in the editor

creationMode

enum<string>

Creation mode of the variation: CODE_BASE, GRAPHICAL, AI or UNDEFINED

Available options:

AI,

CODE_BASE,

GRAPHICAL,

UNDEFINED,

WIDGET

cssCode

string

Code editor CSS code for variation

customJson

string

Custom JSON for this variation

experimentId

integer<int64>

read-only

ID of the experiment this variation belongs to

expositionFrequencyDelaySecondsBetweenTwoExpositions

integer<int64>

Delay in seconds between two exposures

expositionFrequencySameVisit

integer<int32>

Frequency of exposure during the same visit

expositionFrequencySameVisitor

integer<int32>

Frequency of the exposure for the same visitor

expositionFrequencySameVisitorDelaySeconds

integer<int64>

Delay in seconds between exposure for the same visitor

forceNoFlicker

boolean

integer<int64>

Unique ID of the variation

isJsCodeAfterDomReady

boolean

Set to true (which is also the default value) if the code applies once the DOM is ready.

jsCode

string

Code editor javascript code for variation

personalizationId

integer<int64>

read-only

ID of the personalization this variation belongs to

prompt

object

Object that defines an autorun message in the variation. For multipart updates, pass prompt attachments metadata here and send files via multipart part attachments.

Show child attributes

redirection

object

Redirection parameters of a variation

Show child attributes

redirectionStrings

string

deprecated

Redirect URL used for redirecting variation. Deprecated property: use property 'redirection' instead

shadowDom

boolean

ShadowDOM option

Widget template input data in JSON format.

⌘I

Get all variations

curl --request GET \
  --url https://api.kameleoon.com/variations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kameleoon.com/variations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kameleoon.com/variations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kameleoon.com/variations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.kameleoon.com/variations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "name": "<string>",
    "siteId": 123,
    "color": 123,
    "creationMode": "AI",
    "cssCode": "<string>",
    "customJson": "<string>",
    "experimentId": 123,
    "expositionFrequencyDelaySecondsBetweenTwoExpositions": 123,
    "expositionFrequencySameVisit": 123,
    "expositionFrequencySameVisitor": 123,
    "expositionFrequencySameVisitorDelaySeconds": 123,
    "forceNoFlicker": true,
    "id": 123,
    "isJsCodeAfterDomReady": true,
    "jsCode": "<string>",
    "personalizationId": 123,
    "prompt": {
      "textInput": "<string>",
      "attachments": [
        {
          "mediaType": "IMAGE",
          "name": "US-39613 Image attachment",
          "type": "TEMPORARY"
        }
      ],
      "promptSource": "<string>"
    },
    "redirection": {
      "includeQueryParameters": true,
      "parameters": "param1=foo&param2=bar",
      "type": "GLOBAL_REDIRECTION",
      "url": "www.kameleoon.com"
    },
    "redirectionStrings": "<string>",
    "shadowDom": true,
    "widgetTemplateInput": "<string>"
  }
]

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

APIs

Authorizations

Query Parameters

Response