Skip to main content
GET
/
v1
/
workflows
/
abtest
/
instances
List Abtest
curl --request GET \
  --url https://experiments.confidence.dev/v1/workflows/abtest/instances \
  --header 'Authorization: Bearer <token>'
{
  "abtests": [
    {
      "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": [
        {}
      ],
      "abtest": {
        "flag": "<string>",
        "rollout": "<string>",
        "treatments": [
          {
            "variant": "<string>",
            "weight": 123,
            "description": "<string>",
            "displayName": "<string>",
            "imageUri": "<string>",
            "name": "<string>"
          }
        ]
      },
      "decision": {
        "conclusion": "<string>",
        "outcome": {},
        "treatment": "<string>"
      },
      "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>"
      },
      "hypothesis": {
        "text": "<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>"
        }
      },
      "report": {
        "sections": [
          {
            "hypothesisData": {
              "hypothesis": "<string>"
            },
            "id": "<string>",
            "imagesData": {
              "images": [
                {
                  "id": "<string>",
                  "imageUri": "<string>",
                  "label": "<string>",
                  "text": "<string>"
                }
              ]
            },
            "metricsData": {
              "metrics": [
                {
                  "hidden": true,
                  "metric": "<string>",
                  "metricName": "<string>",
                  "treatments": [
                    {
                      "treatment": "<string>",
                      "hidden": true
                    }
                  ]
                }
              ]
            },
            "nextData": {
              "text": "<string>",
              "title": "<string>"
            },
            "outcomeData": {
              "conclusion": "<string>",
              "outcome": "<string>"
            },
            "recommendationsData": {
              "content": [
                {
                  "id": "<string>",
                  "shippingRecommendation": "<string>",
                  "text": "<string>",
                  "variant": "<string>"
                }
              ]
            },
            "resultsData": {
              "text": "<string>",
              "title": "<string>"
            },
            "summaryData": {
              "imageUri": "<string>",
              "text": "<string>",
              "title": "<string>"
            }
          }
        ],
        "name": "<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": {}
      },
      "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": {}
      }
    }
  ],
  "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

abtests
Abtest · object[]

Abtest: List of abtests.

nextPageToken
string

Token for fetching the next page of results.