Update Rollout

Updates an existing rollout.

PATCH /v1/workflows/rollout/instances/{instance}

Update Rollout

cURL

curl --request PATCH \
  --url https://experiments.confidence.dev/v1/workflows/rollout/instances/{instance} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "displayName": "<string>",
  "state": "<string>",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "owner": "<string>",
  "jobQueue": {},
  "pendingTransition": {},
  "checks": [
    {}
  ],
  "stateHistory": [
    {}
  ],
  "possibleTransitions": [
    "<string>"
  ],
  "lockedDataKeys": [
    "<string>"
  ],
  "workflowVersion": "<string>",
  "surfaces": [
    "<string>"
  ],
  "transitionStatus": {},
  "deleteTime": {},
  "labels": [
    {}
  ],
  "explore": {
    "exploratoryAnalyses": [
      {}
    ]
  },
  "exposure": {
    "exposure": [
      {}
    ]
  },
  "flags": {
    "audiences": [
      {}
    ],
    "flag": "<string>",
    "ignoreTargetingForSticky": true,
    "intakePaused": true,
    "materialization": "<string>",
    "rule": "<string>",
    "segment": "<string>",
    "stickyAssignments": true,
    "targetingKeySelector": "<string>"
  },
  "metrics": {
    "bucket": {},
    "metrics": [
      {}
    ],
    "assignmentTable": "<string>",
    "entity": "<string>",
    "exposureCalculation": "<string>",
    "exposureFilter": {},
    "exposureMetric": "<string>",
    "exposureMetricCalculation": "<string>",
    "exposureMetricSchedule": "<string>",
    "exposureTable": "<string>",
    "exposureTableSchedule": "<string>",
    "filters": [
      {}
    ]
  },
  "planning": {
    "actual": {},
    "planned": {}
  },
  "recommendations": {
    "recommendations": [
      {}
    ],
    "treatmentRecommendations": [
      {}
    ]
  },
  "reviews": {
    "approvalRequired": true,
    "optionalReviews": [
      {}
    ],
    "requiredReviews": [
      {}
    ],
    "reviewId": "<string>",
    "status": {}
  },
  "rollout": {
    "monitoringDisabled": true,
    "abtest": "<string>",
    "controlAssignmentId": "<string>",
    "controlVariant": "<string>",
    "description": "<string>",
    "flag": "<string>",
    "reach": "<string>",
    "schedule": {},
    "treatmentGroupProportion": 123,
    "variant": "<string>",
    "variantAssignmentId": "<string>",
    "variantImageUri": "<string>"
  },
  "samplesize": {
    "error": "<string>",
    "exposure": {},
    "exposureSource": {},
    "metrics": [
      {}
    ],
    "requiredSampleSize": {},
    "state": {},
    "statsParameters": {}
  },
  "stats": {
    "alpha": 123,
    "analysisResult": "<string>",
    "analysisResults": [
      {}
    ],
    "fallbackSampleSize": "<string>",
    "metricInformation": [
      {}
    ],
    "metricMethods": [
      {}
    ],
    "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

The body is of type object.

Response

200 - application/json

OK

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.

Show child attributes

explore · object

Module data for explore

Show child attributes

exposure · object

Module data for exposure

Show child attributes

flags · object

Module data for flags

Show child attributes

metrics · object

Module data for metrics

Show child attributes

planning · object

Module data for planning

Show child attributes

recommendations · object

Module data for recommendations

Show child attributes

reviews · object

Module data for reviews

Show child attributes

rollout · object

Module data for rollout

Show child attributes

samplesize · object

Module data for samplesize

Show child attributes

stats · object

Module data for stats

Show child attributes