Request personalization's results - Kameleoon Documentation

POST

personalizations

{personalizationId}

results

Request personalization's results

curl --request POST \
  --url https://api.kameleoon.com/personalizations/{personalizationId}/results \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dateIntervals": [
    {
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z"
    }
  ],
  "visitorData": false,
  "allVariationsData": false,
  "bayesian": false,
  "sequentialTesting": false,
  "enabledMultipleTesting": false,
  "referenceVariationId": "<string>",
  "breakdown": {},
  "goalsIds": [
    123
  ],
  "goalIdsCuped": [
    123
  ],
  "filters": [
    {
      "type": "<string>",
      "include": true
    }
  ],
  "callbackUrl": "<string>"
}
'

import requests

url = "https://api.kameleoon.com/personalizations/{personalizationId}/results"

payload = {
    "dateIntervals": [
        {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
        }
    ],
    "visitorData": False,
    "allVariationsData": False,
    "bayesian": False,
    "sequentialTesting": False,
    "enabledMultipleTesting": False,
    "referenceVariationId": "<string>",
    "breakdown": {},
    "goalsIds": [123],
    "goalIdsCuped": [123],
    "filters": [
        {
            "type": "<string>",
            "include": True
        }
    ],
    "callbackUrl": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dateIntervals: [{start: '2023-11-07T05:31:56Z', end: '2023-11-07T05:31:56Z'}],
    visitorData: false,
    allVariationsData: false,
    bayesian: false,
    sequentialTesting: false,
    enabledMultipleTesting: false,
    referenceVariationId: '<string>',
    breakdown: {},
    goalsIds: [123],
    goalIdsCuped: [123],
    filters: [{type: '<string>', include: true}],
    callbackUrl: '<string>'
  })
};

fetch('https://api.kameleoon.com/personalizations/{personalizationId}/results', 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/personalizations/{personalizationId}/results",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dateIntervals' => [
        [
                'start' => '2023-11-07T05:31:56Z',
                'end' => '2023-11-07T05:31:56Z'
        ]
    ],
    'visitorData' => false,
    'allVariationsData' => false,
    'bayesian' => false,
    'sequentialTesting' => false,
    'enabledMultipleTesting' => false,
    'referenceVariationId' => '<string>',
    'breakdown' => [
        
    ],
    'goalsIds' => [
        123
    ],
    'goalIdsCuped' => [
        123
    ],
    'filters' => [
        [
                'type' => '<string>',
                'include' => true
        ]
    ],
    'callbackUrl' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.kameleoon.com/personalizations/{personalizationId}/results"

	payload := strings.NewReader("{\n  \"dateIntervals\": [\n    {\n      \"start\": \"2023-11-07T05:31:56Z\",\n      \"end\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"visitorData\": false,\n  \"allVariationsData\": false,\n  \"bayesian\": false,\n  \"sequentialTesting\": false,\n  \"enabledMultipleTesting\": false,\n  \"referenceVariationId\": \"<string>\",\n  \"breakdown\": {},\n  \"goalsIds\": [\n    123\n  ],\n  \"goalIdsCuped\": [\n    123\n  ],\n  \"filters\": [\n    {\n      \"type\": \"<string>\",\n      \"include\": true\n    }\n  ],\n  \"callbackUrl\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.kameleoon.com/personalizations/{personalizationId}/results")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dateIntervals\": [\n    {\n      \"start\": \"2023-11-07T05:31:56Z\",\n      \"end\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"visitorData\": false,\n  \"allVariationsData\": false,\n  \"bayesian\": false,\n  \"sequentialTesting\": false,\n  \"enabledMultipleTesting\": false,\n  \"referenceVariationId\": \"<string>\",\n  \"breakdown\": {},\n  \"goalsIds\": [\n    123\n  ],\n  \"goalIdsCuped\": [\n    123\n  ],\n  \"filters\": [\n    {\n      \"type\": \"<string>\",\n      \"include\": true\n    }\n  ],\n  \"callbackUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kameleoon.com/personalizations/{personalizationId}/results")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dateIntervals\": [\n    {\n      \"start\": \"2023-11-07T05:31:56Z\",\n      \"end\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"visitorData\": false,\n  \"allVariationsData\": false,\n  \"bayesian\": false,\n  \"sequentialTesting\": false,\n  \"enabledMultipleTesting\": false,\n  \"referenceVariationId\": \"<string>\",\n  \"breakdown\": {},\n  \"goalsIds\": [\n    123\n  ],\n  \"goalIdsCuped\": [\n    123\n  ],\n  \"filters\": [\n    {\n      \"type\": \"<string>\",\n      \"include\": true\n    }\n  ],\n  \"callbackUrl\": \"<string>\"\n}"

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

{
  "dataCode": "89599333501501534304101214660291496129464311669540935471556471877530843827432"
}

{
  "serviceName": "<string>",
  "message": "<string>"
}

{
  "serviceName": "<string>",
  "message": "<string>"
}

{
  "serviceName": "<string>",
  "message": "<string>"
}

{
  "serviceName": "<string>",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

personalizationId

integer<int64>

required

Body

application/json

dateIntervals

object[]

required

Date boundaries to include only the results from the specified time period(s).

Show child attributes

conversionType

enum<string>

required

Type of conversions to use for calculating reliability, improvement rate, and other metrics

Available options:

ALL_CONVERSION,

CONVERTED_VISITS

visitorData

boolean

default:false

Set to true to include data from unique visitors only. By default, the report includes all visitor data.

allVariationsData

boolean

default:false

Set to true to include data from all variations at once.

bayesian

boolean

default:false

Includes the current Bayesian result probability for the experiment in the report.

sequentialTesting

boolean

default:false

Enables the sequential testing result for the experiment in the report.

enabledMultipleTesting

boolean

default:false

Enables multiple testing correction for the experiment in the report.

referenceVariationId

string

Unique ID of the variation that you want to use as the reference variation.

breakdown

object

Parameter by which you want to segment the report, instead of by time interval. When the request specifies this field, the report ignores the interval field. A request accepts only one breakdown object.

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

goalsIds

integer<int64>[]

Specifies which goals to include in the report. Use an empty list [] to exclude all goals. Use null to include all goals. Use a list of goal IDs [123, 456] to include only those goals.

goalIdsCuped

integer<int64>[]

Specifies which CUPED goals to include in the report. Use an empty list [] to exclude all CUPED goals. Use null to include all CUPED goals. Use a list of CUPED goal IDs [123, 456] to include only those goals.

filters

object[]

List of filters to apply to the data included in the report.

Show child attributes

callbackUrl

string

Callback URL that you want to send the data response to.

Response

dataCode

string

Hash code containing information about the data request, such as dates, goals, variations, format, filters, and so on. Use this code in the Audience poll or Poll results operations to obtain actual results. There are two possible formats for the code, depending on the context: 123...123 or 123...123|123...123. For example, the Get global audience operation generates the latter.

Example:

"89599333501501534304101214660291496129464311669540935471556471877530843827432"

⌘I

Request personalization's results

curl --request POST \
  --url https://api.kameleoon.com/personalizations/{personalizationId}/results \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dateIntervals": [
    {
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z"
    }
  ],
  "visitorData": false,
  "allVariationsData": false,
  "bayesian": false,
  "sequentialTesting": false,
  "enabledMultipleTesting": false,
  "referenceVariationId": "<string>",
  "breakdown": {},
  "goalsIds": [
    123
  ],
  "goalIdsCuped": [
    123
  ],
  "filters": [
    {
      "type": "<string>",
      "include": true
    }
  ],
  "callbackUrl": "<string>"
}
'

import requests

url = "https://api.kameleoon.com/personalizations/{personalizationId}/results"

payload = {
    "dateIntervals": [
        {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
        }
    ],
    "visitorData": False,
    "allVariationsData": False,
    "bayesian": False,
    "sequentialTesting": False,
    "enabledMultipleTesting": False,
    "referenceVariationId": "<string>",
    "breakdown": {},
    "goalsIds": [123],
    "goalIdsCuped": [123],
    "filters": [
        {
            "type": "<string>",
            "include": True
        }
    ],
    "callbackUrl": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dateIntervals: [{start: '2023-11-07T05:31:56Z', end: '2023-11-07T05:31:56Z'}],
    visitorData: false,
    allVariationsData: false,
    bayesian: false,
    sequentialTesting: false,
    enabledMultipleTesting: false,
    referenceVariationId: '<string>',
    breakdown: {},
    goalsIds: [123],
    goalIdsCuped: [123],
    filters: [{type: '<string>', include: true}],
    callbackUrl: '<string>'
  })
};

fetch('https://api.kameleoon.com/personalizations/{personalizationId}/results', 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/personalizations/{personalizationId}/results",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dateIntervals' => [
        [
                'start' => '2023-11-07T05:31:56Z',
                'end' => '2023-11-07T05:31:56Z'
        ]
    ],
    'visitorData' => false,
    'allVariationsData' => false,
    'bayesian' => false,
    'sequentialTesting' => false,
    'enabledMultipleTesting' => false,
    'referenceVariationId' => '<string>',
    'breakdown' => [
        
    ],
    'goalsIds' => [
        123
    ],
    'goalIdsCuped' => [
        123
    ],
    'filters' => [
        [
                'type' => '<string>',
                'include' => true
        ]
    ],
    'callbackUrl' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.kameleoon.com/personalizations/{personalizationId}/results"

	payload := strings.NewReader("{\n  \"dateIntervals\": [\n    {\n      \"start\": \"2023-11-07T05:31:56Z\",\n      \"end\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"visitorData\": false,\n  \"allVariationsData\": false,\n  \"bayesian\": false,\n  \"sequentialTesting\": false,\n  \"enabledMultipleTesting\": false,\n  \"referenceVariationId\": \"<string>\",\n  \"breakdown\": {},\n  \"goalsIds\": [\n    123\n  ],\n  \"goalIdsCuped\": [\n    123\n  ],\n  \"filters\": [\n    {\n      \"type\": \"<string>\",\n      \"include\": true\n    }\n  ],\n  \"callbackUrl\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.kameleoon.com/personalizations/{personalizationId}/results")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dateIntervals\": [\n    {\n      \"start\": \"2023-11-07T05:31:56Z\",\n      \"end\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"visitorData\": false,\n  \"allVariationsData\": false,\n  \"bayesian\": false,\n  \"sequentialTesting\": false,\n  \"enabledMultipleTesting\": false,\n  \"referenceVariationId\": \"<string>\",\n  \"breakdown\": {},\n  \"goalsIds\": [\n    123\n  ],\n  \"goalIdsCuped\": [\n    123\n  ],\n  \"filters\": [\n    {\n      \"type\": \"<string>\",\n      \"include\": true\n    }\n  ],\n  \"callbackUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kameleoon.com/personalizations/{personalizationId}/results")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dateIntervals\": [\n    {\n      \"start\": \"2023-11-07T05:31:56Z\",\n      \"end\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"visitorData\": false,\n  \"allVariationsData\": false,\n  \"bayesian\": false,\n  \"sequentialTesting\": false,\n  \"enabledMultipleTesting\": false,\n  \"referenceVariationId\": \"<string>\",\n  \"breakdown\": {},\n  \"goalsIds\": [\n    123\n  ],\n  \"goalIdsCuped\": [\n    123\n  ],\n  \"filters\": [\n    {\n      \"type\": \"<string>\",\n      \"include\": true\n    }\n  ],\n  \"callbackUrl\": \"<string>\"\n}"

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

{
  "dataCode": "89599333501501534304101214660291496129464311669540935471556471877530843827432"
}

{
  "serviceName": "<string>",
  "message": "<string>"
}

{
  "serviceName": "<string>",
  "message": "<string>"
}

{
  "serviceName": "<string>",
  "message": "<string>"
}

{
  "serviceName": "<string>",
  "message": "<string>"
}

APIs

Authorizations

Path Parameters

Body

Response