Experiment programs: conclude, start

Reference for Experiment, one group of Experiment programs.

Experiment.conclude

Conclude ends an Experiment with a decision to ship, kill, or iterate, recorded as a Decision. Verb page.

Text

do: return await $.Experiment.conclude(input)

Inputs

Input	Type	Required	Description
`experiment`	Experiment	required	The running Experiment.
`decision`	`string`	required	One of `ship`, `kill`, `iterate`.

Returns

Output	Type	Required	Description
`decision`	Decision	required	The recorded Decision.
`experiment`	Experiment	required	The Experiment, now concluded.

Refuses when

Check	Error	Fix	Then call
The input does not match the schema of the operation.	`invalid-input`	Read the schema of the operation, then send every required field with the right type.	None.
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Experiment.conclude({ experiment: 'experiment_IyIJJPngKt', decision: 'ship' })"
  }
}

Start opens an Experiment, splits traffic across its variants, and begins measuring its primary and guardrail Metrics. Verb page.