Patch experiment

Update an experiment. Updating an experiment uses the semantic patch format.

To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch.

Instructions

Semantic patch requests support the following kind instructions for updating experiments.

updateName

Updates the experiment name.

Parameters
  • value: The new name.

Here’s an example:

1{
2 "instructions": [{
3 "kind": "updateName",
4 "value": "Example updated experiment name"
5 }]
6}

updateDescription

Updates the experiment description.

Parameters
  • value: The new description.

Here’s an example:

1{
2 "instructions": [{
3 "kind": "updateDescription",
4 "value": "Example updated description"
5 }]
6}

startIteration

Starts a new iteration for this experiment. You must create a new iteration before calling this instruction.

An iteration may not be started until it meets the following criteria:

  • Its associated flag is toggled on and is not archived
  • Its randomizationUnit is set
  • At least one of its treatments has a non-zero allocationPercent
Parameters
  • changeJustification: The reason for starting a new iteration. Required when you call startIteration on an already running experiment, otherwise optional.

Here’s an example:

1{
2 "instructions": [{
3 "kind": "startIteration",
4 "changeJustification": "It's time to start a new iteration"
5 }]
6}

stopIteration

Stops the current iteration for this experiment.

Parameters
  • winningTreatmentId: The ID of the winning treatment. Treatment IDs are returned as part of the Get experiment response. They are the _id of each element in the treatments array.
  • winningReason: The reason for the winner

Here’s an example:

1{
2 "instructions": [{
3 "kind": "stopIteration",
4 "winningTreatmentId": "3a548ec2-72ac-4e59-8518-5c24f5609ccf",
5 "winningReason": "Example reason to stop the iteration"
6 }]
7}

archiveExperiment

Archives this experiment. Archived experiments are hidden by default in the LaunchDarkly user interface. You cannot start new iterations for archived experiments.

Here’s an example:

1{
2 "instructions": [{ "kind": "archiveExperiment" }]
3}

restoreExperiment

Restores an archived experiment. After restoring an experiment, you can start new iterations for it again.

Here’s an example:

1{
2 "instructions": [{ "kind": "restoreExperiment" }]
3}

Path parameters

projectKeystringRequired
The project key
environmentKeystringRequired
The environment key
experimentKeystringRequired
The experiment key

Headers

AuthorizationstringRequired

Request

This endpoint expects an object.
instructionslist of maps from strings to anyRequired

The instructions to perform when updating. This should be an array with objects that look like <code>{“kind”: “update_action”}</code>. Some instructions also require a <code>value</code> field in the array element.

commentstringOptional
Optional comment describing the update

Response

Experiment response
keystring
The experiment key
namestring
The experiment name
_maintainerIdstring
The ID of the member who maintains this experiment.
_creationDatelong
Timestamp of when the experiment was created
environmentKeystring
_idstringOptional
The experiment ID
descriptionstringOptional
The experiment description
archivedDatelongOptional
Timestamp of when the experiment was archived
holdoutIdstringOptional
The holdout ID
currentIterationobjectOptional
Details on the current iteration
draftIterationobjectOptional
Details on the current iteration. This iteration may be already started, or may still be a draft.
previousIterationslist of objectsOptional
Details on the previous iterations for this experiment.

Errors