Skip to main content
POST
Create experiment run

Authorizations

Authorization
string
header
required

Use an Observe API key from the management console. The key selects the project and must grant the permission listed on the operation. Keep this key on your server.

Body

application/json
experimentID
string
required

ID of the experiment (format exp-<number>)

name
string
required
startMs
integer<int64>
required

Start of the run in milliseconds since epoch

variantIDs
string[]
required

Selected variant IDs (format exv-<number>)

timeSeriesDefinitionIDs
string[]
required

Time-series definition IDs to break down for this run (format tsd-<number>)

description
string
endMs
integer<int64>

Optional end of the run in milliseconds since epoch (open-ended if omitted)

groups
object[]

Optional A/B evaluation arms (control vs treatment) over the selected variants. Omit for a breakdown-only run.

Response

Experiment run created.

id
string
required

ID of the experiment run (format exr-<number>).

experimentID
string
required

ID of the experiment (format exp-<number>).

name
string
required
startMs
integer<int64>
required
variantIDs
string[]
required
timeSeriesDefinitionIDs
string[]
required

Time-series definition IDs (format tsd-<number>).

createdMs
integer<int64>
required
updatedMs
integer<int64>
required
description
string
endMs
integer<int64>
groups
object[]

A/B evaluation arms (control vs treatment). Absent for breakdown-only runs.