Skip to main content
PATCH
/
v1
/
workflows
/
rollout
/
instances
/
{instance}
Update Rollout
curl --request PATCH \
  --url https://experiments.confidence.dev/v1/workflows/rollout/instances/{instance} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "name": "<string>",
  "owner": "<string>",
  "jobQueue": {
    "isEnabled": true,
    "items": [
      {
        "key": "<string>",
        "func": "<string>",
        "runTime": {},
        "isActive": true,
        "parameters": {}
      }
    ]
  },
  "workflowVersion": "<string>",
  "surfaces": [
    "<string>"
  ],
  "labels": [
    {}
  ],
  "explore": {
    "exploratoryAnalyses": [
      {
        "createTime": "<string>",
        "id": "<string>",
        "messages": [
          "<string>"
        ],
        "metrics": [
          {
            "dimensions": [
              {
                "column": "<string>",
                "factTable": "<string>",
                "dimensionTable": "<string>"
              }
            ],
            "name": "<string>",
            "calculation": "<string>",
            "scheduledCalculation": "<string>"
          }
        ],
        "name": "<string>",
        "state": {},
        "updateTime": "<string>",
        "analysisResults": [
          {
            "analysisResult": "<string>",
            "exposureFilterName": "<string>"
          }
        ],
        "conclusion": {
          "text": "<string>",
          "updateTime": "<string>"
        },
        "createdBy": "<string>",
        "endTime": "<string>",
        "labels": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "splitByExposureFilters": true,
        "startTime": "<string>",
        "useCustomDateRange": true,
        "useScheduledCalculation": true
      }
    ]
  },
  "exposure": {
    "exposure": [
      {
        "totalExposureCount": 123,
        "treatment": "<string>",
        "exposureFilter": "<string>"
      }
    ]
  },
  "flags": {
    "audiences": [
      {
        "id": "<string>",
        "displayName": "<string>",
        "intakePaused": true,
        "launchTime": "<string>",
        "materialization": "<string>",
        "rule": "<string>",
        "segment": "<string>",
        "stopTime": "<string>"
      }
    ],
    "flag": "<string>",
    "ignoreTargetingForSticky": true,
    "intakePaused": true,
    "materialization": "<string>",
    "rule": "<string>",
    "segment": "<string>",
    "stickyAssignments": true,
    "targetingKeySelector": "<string>"
  },
  "metrics": {
    "bucket": {},
    "metrics": [
      {
        "metric": "<string>",
        "calculation": "<string>",
        "metricRole": {
          "metricKind": {},
          "minimumDetectableEffect": 123,
          "nonInferiorityMargin": 123
        },
        "preferredDirection": {},
        "schedule": "<string>",
        "surface": "<string>",
        "surfaceOnly": true
      }
    ],
    "assignmentTable": "<string>",
    "entity": "<string>",
    "exposureCalculation": "<string>",
    "exposureFilter": {
      "displayName": "<string>",
      "factTable": "<string>",
      "filter": {
        "criteria": [
          {}
        ],
        "expression": {
          "ref": "<string>",
          "not": {},
          "and": {
            "operands": [
              {}
            ]
          },
          "or": {
            "operands": [
              {}
            ]
          }
        }
      }
    },
    "exposureMetric": "<string>",
    "exposureMetricCalculation": "<string>",
    "exposureMetricSchedule": "<string>",
    "exposureTable": "<string>",
    "exposureTableSchedule": "<string>",
    "filters": [
      {
        "displayName": "<string>",
        "factTable": "<string>",
        "filter": {
          "criteria": [
            {}
          ],
          "expression": {
            "ref": "<string>",
            "not": {},
            "and": {
              "operands": [
                {}
              ]
            },
            "or": {
              "operands": [
                {}
              ]
            }
          }
        }
      }
    ]
  },
  "planning": {
    "actual": {
      "endTime": "<string>",
      "runtime": "<string>",
      "startTime": "<string>"
    },
    "planned": {
      "endTime": "<string>",
      "runtime": "<string>",
      "startTime": "<string>"
    }
  },
  "reviews": {
    "approvalRequired": true,
    "optionalReviews": [
      {
        "state": {},
        "responses": [
          {
            "reviewer": "<string>",
            "state": {},
            "commentId": "<string>",
            "groups": [
              "<string>"
            ],
            "id": "<string>",
            "stale": true
          }
        ],
        "surface": "<string>"
      }
    ],
    "requiredReviews": [
      {
        "state": {},
        "responses": [
          {
            "reviewer": "<string>",
            "state": {},
            "commentId": "<string>",
            "groups": [
              "<string>"
            ],
            "id": "<string>",
            "stale": true
          }
        ],
        "surface": "<string>"
      }
    ],
    "reviewId": "<string>",
    "status": {}
  },
  "rollout": {
    "monitoringDisabled": true,
    "abtest": "<string>",
    "controlAssignmentId": "<string>",
    "controlVariant": "<string>",
    "description": "<string>",
    "flag": "<string>",
    "reach": "<string>",
    "schedule": {
      "steps": [
        {
          "durationSincePreviousStep": "<string>",
          "reach": "<string>",
          "status": {},
          "updateTime": "<string>"
        }
      ],
      "state": {},
      "stateReason": {
        "failed": {}
      }
    },
    "treatmentGroupProportion": 123,
    "variant": "<string>",
    "variantAssignmentId": "<string>",
    "variantImageUri": "<string>"
  },
  "samplesize": {
    "error": "<string>",
    "exposure": {
      "assignmentTable": {
        "assignmentTable": "<string>",
        "filters": {
          "exposureFilter": "<string>"
        },
        "runtime": "<string>",
        "samplingFactor": 123
      },
      "existingInstance": {
        "workflowInstance": "<string>",
        "exposureTableSchedule": "<string>"
      },
      "endTime": "<string>",
      "startTime": "<string>"
    },
    "exposureSource": {
      "workflowInstance": "<string>",
      "assignmentTable": "<string>",
      "exposureTableSchedule": "<string>",
      "filters": {
        "assignmentFilter": {
          "criteria": [
            {}
          ],
          "expression": {
            "ref": "<string>",
            "not": {},
            "and": {
              "operands": [
                {}
              ]
            },
            "or": {
              "operands": [
                {}
              ]
            }
          }
        },
        "entityFilter": {
          "dimensionTable": "<string>",
          "filter": {
            "criteria": [
              {}
            ],
            "expression": {
              "ref": "<string>",
              "not": {},
              "and": {
                "operands": [
                  {}
                ]
              },
              "or": {
                "operands": [
                  {}
                ]
              }
            }
          }
        },
        "exposureFilter": "<string>"
      },
      "runtime": "<string>",
      "samplingFactor": 123
    },
    "metrics": [
      {
        "metric": "<string>",
        "error": "<string>",
        "forecastedData": [
          {
            "dayIndex": 123,
            "expectedSampleSize": 123,
            "requiredSampleSize": 123
          }
        ],
        "observedData": [
          {
            "dayIndex": 123,
            "expectedSampleSize": 123,
            "mean": 123,
            "requiredSampleSize": 123,
            "variance": 123
          }
        ],
        "requiredSampleSize": 123,
        "state": {},
        "summaryStats": {
          "count": 123,
          "mean": 123,
          "variance": 123,
          "varianceReductionRate": 123
        },
        "type": {}
      }
    ],
    "requiredSampleSize": 123,
    "state": {},
    "statsParameters": {
      "alpha": 123,
      "power": 123,
      "testHorizonStrategy": {},
      "allocationProportion": "<string>"
    }
  },
  "stats": {
    "alpha": 123,
    "analysisResult": "<string>",
    "analysisResults": [
      {
        "analysisResult": "<string>",
        "exposureFilterName": "<string>"
      }
    ],
    "fallbackSampleSize": "<string>",
    "metricInformation": [
      {
        "metricName": "<string>",
        "expectedSampleSize": "<string>"
      }
    ],
    "metricMethods": [
      {
        "method": {},
        "metricName": "<string>"
      }
    ],
    "power": 123,
    "testHorizonStrategy": {}
  }
}
'
{
  "displayName": "<string>",
  "state": "<string>",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "owner": "<string>",
  "jobQueue": {
    "isEnabled": true,
    "items": [
      {
        "key": "<string>",
        "func": "<string>",
        "runTime": {},
        "isActive": true,
        "parameters": {}
      }
    ]
  },
  "pendingTransition": {
    "transitionAction": "<string>",
    "targetState": "<string>",
    "succeededSteps": [
      "<string>"
    ],
    "failedSteps": [
      {
        "actionStep": "<string>",
        "failuresMessages": [
          "<string>"
        ]
      }
    ],
    "unprocessedSteps": [
      "<string>"
    ],
    "succeededActions": [
      "<string>"
    ],
    "failedActions": [
      {
        "action": "<string>",
        "failuresMessages": [
          "<string>"
        ]
      }
    ],
    "unprocessedActions": [
      "<string>"
    ]
  },
  "checks": [
    {
      "message": "<string>",
      "state": {},
      "persist": true,
      "createTime": {},
      "updateTime": {},
      "creator": "<string>",
      "updater": "<string>",
      "name": "<string>",
      "displayName": "<string>",
      "parent": "<string>",
      "data": {
        "nullValue": {},
        "numberValue": 123,
        "stringValue": "<string>",
        "boolValue": true,
        "structValue": {},
        "listValue": {
          "values": [
            {}
          ]
        }
      },
      "labels": [
        {}
      ]
    }
  ],
  "stateHistory": [
    {
      "state": "<string>",
      "enteredTime": {},
      "exitedTime": {},
      "actualEnteredTime": {},
      "actualExitedTime": {},
      "checks": [
        {
          "message": "<string>",
          "state": {},
          "persist": true,
          "createTime": {},
          "updateTime": {},
          "creator": "<string>",
          "updater": "<string>",
          "name": "<string>",
          "displayName": "<string>",
          "parent": "<string>",
          "data": {
            "nullValue": {},
            "numberValue": 123,
            "stringValue": "<string>",
            "boolValue": true,
            "structValue": {},
            "listValue": {
              "values": [
                {}
              ]
            }
          },
          "labels": [
            {}
          ]
        }
      ]
    }
  ],
  "possibleTransitions": [
    "<string>"
  ],
  "lockedDataKeys": [
    "<string>"
  ],
  "workflowVersion": "<string>",
  "surfaces": [
    "<string>"
  ],
  "transitionStatus": {
    "action": "<string>",
    "initiator": "<string>",
    "running": {
      "startTime": {}
    },
    "completed": {
      "startTime": {},
      "endTime": {}
    },
    "failed": {
      "startTime": {},
      "endTime": {},
      "error": "<string>"
    }
  },
  "deleteTime": {},
  "labels": [
    {}
  ],
  "explore": {
    "exploratoryAnalyses": [
      {
        "createTime": "<string>",
        "id": "<string>",
        "messages": [
          "<string>"
        ],
        "metrics": [
          {
            "dimensions": [
              {
                "column": "<string>",
                "factTable": "<string>",
                "dimensionTable": "<string>"
              }
            ],
            "name": "<string>",
            "calculation": "<string>",
            "scheduledCalculation": "<string>"
          }
        ],
        "name": "<string>",
        "state": {},
        "updateTime": "<string>",
        "analysisResults": [
          {
            "analysisResult": "<string>",
            "exposureFilterName": "<string>"
          }
        ],
        "conclusion": {
          "text": "<string>",
          "updateTime": "<string>"
        },
        "createdBy": "<string>",
        "endTime": "<string>",
        "labels": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "splitByExposureFilters": true,
        "startTime": "<string>",
        "useCustomDateRange": true,
        "useScheduledCalculation": true
      }
    ]
  },
  "exposure": {
    "exposure": [
      {
        "totalExposureCount": 123,
        "treatment": "<string>",
        "exposureFilter": "<string>"
      }
    ]
  },
  "flags": {
    "audiences": [
      {
        "id": "<string>",
        "displayName": "<string>",
        "intakePaused": true,
        "launchTime": "<string>",
        "materialization": "<string>",
        "rule": "<string>",
        "segment": "<string>",
        "stopTime": "<string>"
      }
    ],
    "flag": "<string>",
    "ignoreTargetingForSticky": true,
    "intakePaused": true,
    "materialization": "<string>",
    "rule": "<string>",
    "segment": "<string>",
    "stickyAssignments": true,
    "targetingKeySelector": "<string>"
  },
  "metrics": {
    "bucket": {},
    "metrics": [
      {
        "metric": "<string>",
        "calculation": "<string>",
        "metricRole": {
          "metricKind": {},
          "minimumDetectableEffect": 123,
          "nonInferiorityMargin": 123
        },
        "preferredDirection": {},
        "schedule": "<string>",
        "surface": "<string>",
        "surfaceOnly": true
      }
    ],
    "assignmentTable": "<string>",
    "entity": "<string>",
    "exposureCalculation": "<string>",
    "exposureFilter": {
      "displayName": "<string>",
      "factTable": "<string>",
      "filter": {
        "criteria": [
          {}
        ],
        "expression": {
          "ref": "<string>",
          "not": {},
          "and": {
            "operands": [
              {}
            ]
          },
          "or": {
            "operands": [
              {}
            ]
          }
        }
      }
    },
    "exposureMetric": "<string>",
    "exposureMetricCalculation": "<string>",
    "exposureMetricSchedule": "<string>",
    "exposureTable": "<string>",
    "exposureTableSchedule": "<string>",
    "filters": [
      {
        "displayName": "<string>",
        "factTable": "<string>",
        "filter": {
          "criteria": [
            {}
          ],
          "expression": {
            "ref": "<string>",
            "not": {},
            "and": {
              "operands": [
                {}
              ]
            },
            "or": {
              "operands": [
                {}
              ]
            }
          }
        }
      }
    ]
  },
  "planning": {
    "actual": {
      "endTime": "<string>",
      "runtime": "<string>",
      "startTime": "<string>"
    },
    "planned": {
      "endTime": "<string>",
      "runtime": "<string>",
      "startTime": "<string>"
    }
  },
  "reviews": {
    "approvalRequired": true,
    "optionalReviews": [
      {
        "state": {},
        "responses": [
          {
            "reviewer": "<string>",
            "state": {},
            "commentId": "<string>",
            "groups": [
              "<string>"
            ],
            "id": "<string>",
            "stale": true
          }
        ],
        "surface": "<string>"
      }
    ],
    "requiredReviews": [
      {
        "state": {},
        "responses": [
          {
            "reviewer": "<string>",
            "state": {},
            "commentId": "<string>",
            "groups": [
              "<string>"
            ],
            "id": "<string>",
            "stale": true
          }
        ],
        "surface": "<string>"
      }
    ],
    "reviewId": "<string>",
    "status": {}
  },
  "rollout": {
    "monitoringDisabled": true,
    "abtest": "<string>",
    "controlAssignmentId": "<string>",
    "controlVariant": "<string>",
    "description": "<string>",
    "flag": "<string>",
    "reach": "<string>",
    "schedule": {
      "steps": [
        {
          "durationSincePreviousStep": "<string>",
          "reach": "<string>",
          "status": {},
          "updateTime": "<string>"
        }
      ],
      "state": {},
      "stateReason": {
        "failed": {}
      }
    },
    "treatmentGroupProportion": 123,
    "variant": "<string>",
    "variantAssignmentId": "<string>",
    "variantImageUri": "<string>"
  },
  "samplesize": {
    "error": "<string>",
    "exposure": {
      "assignmentTable": {
        "assignmentTable": "<string>",
        "filters": {
          "exposureFilter": "<string>"
        },
        "runtime": "<string>",
        "samplingFactor": 123
      },
      "existingInstance": {
        "workflowInstance": "<string>",
        "exposureTableSchedule": "<string>"
      },
      "endTime": "<string>",
      "startTime": "<string>"
    },
    "exposureSource": {
      "workflowInstance": "<string>",
      "assignmentTable": "<string>",
      "exposureTableSchedule": "<string>",
      "filters": {
        "assignmentFilter": {
          "criteria": [
            {}
          ],
          "expression": {
            "ref": "<string>",
            "not": {},
            "and": {
              "operands": [
                {}
              ]
            },
            "or": {
              "operands": [
                {}
              ]
            }
          }
        },
        "entityFilter": {
          "dimensionTable": "<string>",
          "filter": {
            "criteria": [
              {}
            ],
            "expression": {
              "ref": "<string>",
              "not": {},
              "and": {
                "operands": [
                  {}
                ]
              },
              "or": {
                "operands": [
                  {}
                ]
              }
            }
          }
        },
        "exposureFilter": "<string>"
      },
      "runtime": "<string>",
      "samplingFactor": 123
    },
    "metrics": [
      {
        "metric": "<string>",
        "error": "<string>",
        "forecastedData": [
          {
            "dayIndex": 123,
            "expectedSampleSize": 123,
            "requiredSampleSize": 123
          }
        ],
        "observedData": [
          {
            "dayIndex": 123,
            "expectedSampleSize": 123,
            "mean": 123,
            "requiredSampleSize": 123,
            "variance": 123
          }
        ],
        "requiredSampleSize": 123,
        "state": {},
        "summaryStats": {
          "count": 123,
          "mean": 123,
          "variance": 123,
          "varianceReductionRate": 123
        },
        "type": {}
      }
    ],
    "requiredSampleSize": 123,
    "state": {},
    "statsParameters": {
      "alpha": 123,
      "power": 123,
      "testHorizonStrategy": {},
      "allocationProportion": "<string>"
    }
  },
  "stats": {
    "alpha": 123,
    "analysisResult": "<string>",
    "analysisResults": [
      {
        "analysisResult": "<string>",
        "exposureFilterName": "<string>"
      }
    ],
    "fallbackSampleSize": "<string>",
    "metricInformation": [
      {
        "metricName": "<string>",
        "expectedSampleSize": "<string>"
      }
    ],
    "metricMethods": [
      {
        "method": {},
        "metricName": "<string>"
      }
    ],
    "power": 123,
    "testHorizonStrategy": {}
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
instance
string
required

Query Parameters

​
updateMask
object

Field mask specifying which fields to update.

Body

application/json
​
displayName
string
required

Human-friendly name of this instance.

​
name
string

Unique id of the instance for example workflows/abtest/instances/vxpoqirnwawxzasv4tuu.

​
owner
string

The owner of the resource. If not set will default to the creator.

​
jobQueue
object
​
workflowVersion
string

Version of the workflow that this instance is running.

​
surfaces
string[]

A set of surfaces that this workflow instance belongs to.

​
labels
object[]

Generic labels for the workflow instance.

​
explore
Rollout.ExploreData · object

Rollout.ExploreData: Module data for explore

​
exposure
Rollout.ExposureData · object

Rollout.ExposureData: Module data for exposure

​
flags
Rollout.FlagsData · object

Rollout.FlagsData: Module data for flags

​
metrics
Rollout.MetricsData · object

Rollout.MetricsData: Module data for metrics

​
planning
Rollout.PlanningData · object

Rollout.PlanningData: Module data for planning

​
reviews
Rollout.ReviewsData · object

Rollout.ReviewsData: Module data for reviews

​
rollout
Rollout.RolloutData · object

Rollout.RolloutData: Module data for rollout

​
samplesize
Rollout.SampleSizeData · object

Rollout.SampleSizeData: Module data for samplesize

​
stats
Rollout.StatsData · object

Rollout.StatsData: Module data for stats

Response

200 - application/json

Returns a Rollout.

Represents a Rollout.

​
displayName
string
required

Human-friendly name of this instance.

​
state
string
required

Current state of the workflow instance.

​
createTime
object
required

Time when the workflow instance was created.

​
updateTime
object
required

Time when the workflow instance was last updated.

​
creator
string
required

Reference to the identity that created this workflow instance.

​
updater
string
required

Reference to the identity that last updated this workflow instance.

​
name
string

Unique id of the instance for example workflows/abtest/instances/vxpoqirnwawxzasv4tuu.

​
owner
string

The owner of the resource. If not set will default to the creator.

​
jobQueue
object
​
pendingTransition
object

if present, denotes information about an ongoing attempt to transition to another state

​
checks
object[]

A check is a named boolean value that can be used to report possible errors when a workflow instance is in a certain state.

​
stateHistory
object[]

A historical record of previous states that the workflow instance was in.

​
possibleTransitions
string[]

The transitions that this workflow instance can do from its current state.

​
lockedDataKeys
string[]

Module data keys that are currently locked.

​
workflowVersion
string

Version of the workflow that this instance is running.

​
surfaces
string[]

A set of surfaces that this workflow instance belongs to.

​
transitionStatus
object

The status of the latest transition for the instance.

​
deleteTime
object

Time when the workflow instance was deleted.

​
labels
object[]

Generic labels for the workflow instance.

​
explore
Rollout.ExploreData · object

Rollout.ExploreData: Module data for explore

​
exposure
Rollout.ExposureData · object

Rollout.ExposureData: Module data for exposure

​
flags
Rollout.FlagsData · object

Rollout.FlagsData: Module data for flags

​
metrics
Rollout.MetricsData · object

Rollout.MetricsData: Module data for metrics

​
planning
Rollout.PlanningData · object

Rollout.PlanningData: Module data for planning

​
reviews
Rollout.ReviewsData · object

Rollout.ReviewsData: Module data for reviews

​
rollout
Rollout.RolloutData · object

Rollout.RolloutData: Module data for rollout

​
samplesize
Rollout.SampleSizeData · object

Rollout.SampleSizeData: Module data for samplesize

​
stats
Rollout.StatsData · object

Rollout.StatsData: Module data for stats