Export experiment results

curl --request POST \
  --url https://api.kameleoon.com/experiments/{experimentId}/init-export \
  --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>",
  "exportOptions": {
    "columns": [],
    "filterLabels": [
      "<string>"
    ],
    "variationsIds": [
      123
    ],
    "useReferenceVariation": true
  }
}
'

import requests

url = "https://api.kameleoon.com/experiments/{experimentId}/init-export"

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>",
    "exportOptions": {
        "columns": [],
        "filterLabels": ["<string>"],
        "variationsIds": [123],
        "useReferenceVariation": True
    }
}
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>',
    exportOptions: {
      columns: [],
      filterLabels: ['<string>'],
      variationsIds: [123],
      useReferenceVariation: true
    }
  })
};

fetch('https://api.kameleoon.com/experiments/{experimentId}/init-export', 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/experiments/{experimentId}/init-export",
  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>',
    'exportOptions' => [
        'columns' => [
                
        ],
        'filterLabels' => [
                '<string>'
        ],
        'variationsIds' => [
                123
        ],
        'useReferenceVariation' => true
    ]
  ]),
  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/experiments/{experimentId}/init-export"

	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  \"exportOptions\": {\n    \"columns\": [],\n    \"filterLabels\": [\n      \"<string>\"\n    ],\n    \"variationsIds\": [\n      123\n    ],\n    \"useReferenceVariation\": true\n  }\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/experiments/{experimentId}/init-export")
  .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  \"exportOptions\": {\n    \"columns\": [],\n    \"filterLabels\": [\n      \"<string>\"\n    ],\n    \"variationsIds\": [\n      123\n    ],\n    \"useReferenceVariation\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kameleoon.com/experiments/{experimentId}/init-export")

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  \"exportOptions\": {\n    \"columns\": [],\n    \"filterLabels\": [\n      \"<string>\"\n    ],\n    \"variationsIds\": [\n      123\n    ],\n    \"useReferenceVariation\": true\n  }\n}"

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

{
  "dataCode": "89599333501501534304101214660291496129464311669540935471556471877530843827432"
}

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

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

POST

experiments

{experimentId}

init-export

Export experiment results

curl --request POST \
  --url https://api.kameleoon.com/experiments/{experimentId}/init-export \
  --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>",
  "exportOptions": {
    "columns": [],
    "filterLabels": [
      "<string>"
    ],
    "variationsIds": [
      123
    ],
    "useReferenceVariation": true
  }
}
'

import requests

url = "https://api.kameleoon.com/experiments/{experimentId}/init-export"

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>",
    "exportOptions": {
        "columns": [],
        "filterLabels": ["<string>"],
        "variationsIds": [123],
        "useReferenceVariation": True
    }
}
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>',
    exportOptions: {
      columns: [],
      filterLabels: ['<string>'],
      variationsIds: [123],
      useReferenceVariation: true
    }
  })
};

fetch('https://api.kameleoon.com/experiments/{experimentId}/init-export', 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/experiments/{experimentId}/init-export",
  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>',
    'exportOptions' => [
        'columns' => [
                
        ],
        'filterLabels' => [
                '<string>'
        ],
        'variationsIds' => [
                123
        ],
        'useReferenceVariation' => true
    ]
  ]),
  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/experiments/{experimentId}/init-export"

	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  \"exportOptions\": {\n    \"columns\": [],\n    \"filterLabels\": [\n      \"<string>\"\n    ],\n    \"variationsIds\": [\n      123\n    ],\n    \"useReferenceVariation\": true\n  }\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/experiments/{experimentId}/init-export")
  .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  \"exportOptions\": {\n    \"columns\": [],\n    \"filterLabels\": [\n      \"<string>\"\n    ],\n    \"variationsIds\": [\n      123\n    ],\n    \"useReferenceVariation\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kameleoon.com/experiments/{experimentId}/init-export")

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  \"exportOptions\": {\n    \"columns\": [],\n    \"filterLabels\": [\n      \"<string>\"\n    ],\n    \"variationsIds\": [\n      123\n    ],\n    \"useReferenceVariation\": true\n  }\n}"

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

{
  "dataCode": "89599333501501534304101214660291496129464311669540935471556471877530843827432"
}

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

experimentId

integer<int64>

required

Body

application/json

dateIntervals

Date interval · 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 etc

Available options:

ALL_CONVERSION,

CONVERTED_VISITS

visitorData

boolean

default:false

Set to true to only include data from unique visitors. 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

Enables 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

Breakdown · object

Breakdown request argument for splitting data

Breakdown
Conversion metadata breakdown io (variant 1)
Cross campaign breakdown io (variant 1)
Custom datum breakdown io
Interval breakdown io (variant 1)

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

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.

exportOptions

Export options · object

Options for XLSX/PDF exportation.

Show child attributes

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 AudienceController#poll or DataController functions 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, AudienceController#global generates the latter.

Example:

"89599333501501534304101214660291496129464311669540935471556471877530843827432"

Request experiment's results

Get all goals

⌘I