Get Experiment Result's Report

1 min

GET

https://api.optimizely.com/v2/experiments/{experiment_id}/report

Gets the outcome of the experiment as inferred by the Optimizely system upon the evaluation of variations that may or may not have reached statistical significance.

Path Parameters

experiment_idinteger<int64>required
Description
The ID for the Experiment you want to generate reports for
Format
int64

Query Parameters

baseline_variation_idstring<int64>
Description
The ID of the variation to use as the baseline to compare against other variations. Defaults to the first variation if not provided. For an experience in a personalization campaign, the value can also be the string 'holdback'.
Format
int64
start_timestring<date-time>
Description
The start time of the time interval (beginning time included) used to calculate the results over. If unspecified, defaults to the time that the Experiment was first activated. The start time will be rounded the smallest time modulo 5 minutes larger or equal to start_time.
Format
date-time
end_timestring<date-time>
Description
The end of the time interval (end time excluded) used to calculate results over. If unspecified, defaults to the current time if the Experiment is still running, otherwise defaults to the time the experiment was last active. The end time will be rounded to the largest time modulo 5 minutes smaller or equal to end_time. The end_time in the response may be earlier than requested if fresher results are not available yet. In this case, the results will continue to calculate in the background and subsequent requests will eventually return the full results.
Format
date-time
browserstring
Description
Browser to segment results by. This parameter must not be sent with any other segmentation parameters, i.e. any parameters in [device, source, attribute_id, attribute_value].
Allowed
firefoxchromeinternet_exploreroperasafari
devicestring
Description
Device to segment results by. This parameter must not be sent with any other segmentation parameters, i.e. any parameters in [browser, source, attribute_id, attribute_value].
Allowed
desktopipadiphonemobiletablet
sourcestring
Description
Source to segment results by. This parameter must not be sent with any other segmentation parameters, i.e. any parameters in [browser, device, attribute_id, attribute_value]. Campaign: Contains users that arrive on a URL containing a 'utm_campaign,' 'utm_source,' 'gclid,' or 'otm_source' query parameter. If the URL contains one of these parameters, the visitor will count as "Campaign" traffic even if they arrived through search. Direct: Includes all users who do not have any external referrer in their URL. Referral: Includes all users that come from another URL that doesn't count as Campaign.
Allowed
campaigndirectreferralsearch
attribute_idinteger<int64>
Description
ID of the attribute to segment results by. Requests containing attribute_id will return the results for all visitors that have attribute_value for the attribute represented by attribute_id. If present, the attribute_value parameter must also be present, and it cannot be sent with any other segmentation parameters, i.e. any parameters in [browser, device, source].
Format
int64
attribute_valuestring
Description
UTF-8 encoded value correlating to attribute_id. If present, the attribute_id parameter must also be present. This parameter also requires attribute_id to be set, and cannot be sent with any other segmentation parameters, i.e. any parameters in [browser, device, source].
segment_conditionsstring
Description
(BETA) A string representation of a JSON Segment Conditions Expression. This parameter can be either URL-escaped stringified JSON or Base64-encoded stringified JSON using URL-safe alphabet (preferred). Segment Conditions Expressions consist of Logical Expressions and Match Expressions. Logical Expressions are represented as an array of the format [, ...], where the supported operators are "and", "or" and "not". Match Expressions are represented as an object of the format {"attribute_id": <attribute_id>, "attribute_value": [, "match_type": <match_type>]}, where supported values for match_type are "exact" match type will match only an exact string match between "value" string and the attribute value. "substring" match type will match if "value" is a substring of the attribute value. "prefix" match type will match if "value" is a string prefix of the attribute value. "regex" match type will match if "value" is a regular expression match for the attribute value. The default match_type is "exact".

Responses

200Return Experiment Result's Report

ExperimentResultsReport
- end_timestring<date-time>
  Description
  End of the time interval (exclusive) used to generate the report. The time is formatted in ISO 8601.
  Format
  date-time
- experiment_idinteger<int64>
  Example
  3000
  Description
  The unique identifier for the Experiment for which the report is to be generated.
  Format
  int64
- inferred_outcomestring<win | loss | inconclusive>
  Description
  Outcome of the experiment as inferred by the Optimizely system upon the evaluation of variations that may or may not have reached statistical significance.
  Allowed
  winlossinconclusive
- start_timestring<date-time>
  Description
  Start of the time interval (inclusive) used to generate the reports. The time is formatted in ISO 8601.
  Format
  date-time

202The results request has been received but has not yet finished processing. Wait a bit and try again.

204There are no results data for this Experiment yet. Make sure the Experiment is started and try again later

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request GET \
     --url https://api.optimizely.com/v2/experiments/{experiment_id}/report \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/experiments/{experiment_id}/report", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.optimizely.com/v2/experiments/{experiment_id}/report")

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

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

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

python

import requests
import json

url = "https://api.optimizely.com/v2/experiments/{experiment_id}/report"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Return Experiment Result's Report
{
  "end_time": "",
  "experiment_id": 3000,
  "inferred_outcome": "",
  "start_time": ""
}

202

// The results request has been received but has not yet finished processing. Wait a bit and try again.

204

// There are no results data for this Experiment yet. Make sure the Experiment is started and try again later

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}