List Rollout

Lists rollouts with optional filtering and pagination.

GET /v1/workflows/rollout/instances

List Rollout

cURL

curl --request GET \
  --url https://experiments.confidence.dev/v1/workflows/rollout/instances \
  --header 'Authorization: Bearer <token>'

200

{
  "rollouts": [
    {
      "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": {}
      }
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

Authorization · string · header · required

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

Query Parameters

pageSize · object

Maximum number of results to return.

pageToken · string

Token for pagination.

filter · string

Filter expression for results.

orderBy · string

Field to order results by.

Response

200 - application/json

OK

rollouts · object[]

List of rollouts.

Show child attributes

nextPageToken · string

Token for fetching the next page of results.