Summaries of Experiments and Campaigns

1 min

GET

https://api.optimizely.com/v2/experiment_summaries

Summaries of Experiments and Campaigns in a Project

Query Parameters

per_pageinteger
Description
Optional pagination argument that specifies the maximum number of objects to return per request
Default
25
Maximum
100
pageinteger
Description
Optional pagination argument that specifies the page to return. If you have 140 objects and you choose to return 100 objects per page you will be able to access the last 40 objects on page 2. The default value is 1.
Default
1
sortstring
Description
The column to sort by.
Allowed
namelast_modified
orderstring
Description
The order to sort with.
Default
asc
Allowed
ascdesc
project_idinteger<int64>required
Description
Return Experiments and Campaigns for specified project.
Format
int64
archivedboolean
Description
Whether or not to include archived entities. If this parameter is not provided it will default to false and no archived entities will be included. Supersedes status filter.
Default
false
statusstring
Description
Filters search results by the current status of the entity. Specifying multiple statuses will search for entities with ANY of those statuses.
Allowed
runningpausedarchivednot_started

Responses

200Return experiment summary results

ExperimentSummary[]
- archivedboolean
  Example
  False
  Description
  Whether or not the entity is archived.
- createdstring<date-time>
  Description
  The time that the entity was created.
  Format
  date-time
- descriptionstring
  Example
  Test out the hero image on the home page
  Description
  Description for the entity if it has one.
- experiment_typestring
  Example
  a/b
  Description
  The type of experiment
- idinteger
  Description
  ID of the entity
- last_modifiedstring<date-time>
  Description
  The time that the entity was last modified.
  Format
  date-time
- namestring
  Example
  Hero Image Test
  Description
  Name of the entity. This value will be the 'key' of the entity if there is no name.
- project_idinteger
  Description
  ID of the project that contains the entity (if applicable)
- project_namestring
  Description
  Name of the project that contains the entity (if applicable)
- statusstring
  Example
  running
  Description
  The current status for the entity if it has one.
- typestring<experiment | campaign>
  Example
  experiment
  Description
  Type of the entity.
  Allowed
  experimentcampaign

401Invalid credentials

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

403You do not have permission to search the specified Account or Project

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

defaultUnexpected error

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

curl

curl --request GET \
     --url 'https://api.optimizely.com/v2/experiment_summaries?per_page=25&page=1&order=asc&project_id=integer%3Cint64%3E&archived=boolean' \
     --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/experiment_summaries?per_page=25&page=1&order=asc&project_id=integer<int64>&archived=boolean", 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/experiment_summaries?per_page=25&page=1&order=asc&project_id=integer<int64>&archived=boolean")

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/experiment_summaries?per_page=25&page=1&order=asc&project_id=integer<int64>&archived=boolean"

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

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

print(response.text)

200

// Return experiment summary results
[
  {
    "archived": "False",
    "created": "",
    "description": "Test out the hero image on the home page",
    "experiment_type": "a/b",
    "id": 0,
    "last_modified": "",
    "name": "Hero Image Test",
    "project_id": 0,
    "project_name": "",
    "status": "running",
    "type": "experiment"
  }
]

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

403

// You do not have permission to search the specified Account or Project
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

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