Sign in

v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB
ExperimentSummary

Summaries of Experiments and Campaigns

Summaries of Experiments and Campaigns in a Project

get/experiment_summaries

Query parameters

per_pageinteger

Optional pagination argument that specifies the maximum number of objects to return per request

pageinteger

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.

sort'name' | 'last_modified'

The column to sort by.

order'asc' | 'desc'

The order to sort with.

project_idinteger required

Return Experiments and Campaigns for specified project.

archivedboolean

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.

status'running' | 'paused' | 'archived' | 'not_started'

Filters search results by the current status of the entity. Specifying multiple statuses will search for entities with ANY of those statuses.

Response

Return experiment summary results

archivedboolean

Whether or not the entity is archived.

createdstring date-time

The time that the entity was created.

descriptionstring

Description for the entity if it has one.

experiment_typestring

The type of experiment

idinteger

ID of the entity

last_modifiedstring date-time

The time that the entity was last modified.

namestring

Name of the entity. This value will be the 'key' of the entity if there is no name.

project_idinteger

ID of the project that contains the entity (if applicable)

project_namestring

Name of the project that contains the entity (if applicable)

statusstring

The current status for the entity if it has one.

type'experiment' | 'campaign'

Type of the entity.

Example response

[
  {
    "description": "Test out the hero image on the home page",
    "experiment_type": "a/b",
    "name": "Hero Image Test",
    "status": "running",
    "type": "experiment"
  }
]