Stop an experiment

Stop a currently running experiment.

Stops an experiment. After stopping, the experiment enters done status and results can be reviewed. Archived experiment results are stored automatically.

This endpoint does not require the experiment to be in a running state. Calling it on an experiment that is already stopped completes successfully without modifying the experiment data.

Requires the experiment:write or abtesting.write permission.

Request

PUT /experiment/{id}/stop

Path Parameters

ParameterTypeRequiredDescription
idintegerYesThe ID of the experiment to stop.

Headers

HeaderValue
AuthorizationBearer <token>

Response

Returns a confirmation object on success.

Response Body

FieldTypeDescription
okbooleantrue when the experiment was stopped successfully.

Example Response

{
  "ok": true
}
Path Params
integer
required

Experiment ID

Headers
string
required

Makaira Instance ID

Responses

400

Bad Request - the experiment is not running

404

Not Found

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json