Skip to main content
POST
/
v1
/
workflows
/
rollout
/
instances
/
{instance}
:getmandatorymetrics
Execute GetMandatoryMetric
curl --request POST \
  --url https://experiments.confidence.dev/v1/workflows/rollout/instances/{instance}:getmandatorymetrics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "parameters": {}
}
'
{
  "metadata": [
    {
      "metric": "<string>",
      "displayName": "<string>"
    }
  ],
  "metrics": [
    {
      "metric": "<string>",
      "calculation": "<string>",
      "metricRole": {
        "metricKind": {},
        "minimumDetectableEffect": 123,
        "nonInferiorityMargin": 123
      },
      "preferredDirection": {},
      "schedule": "<string>",
      "surface": "<string>",
      "surfaceOnly": true
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

instance
string
required

Body

application/json
parameters
object

Parameters for the function.

Response

200 - application/json

OK

metadata
object[]
required

Metadata for the mandatory metrics

metrics
object[]
required

The list of mandatory metrics