Skip to main content
POST
/
v1
/
workflows
/
rollout
/
instances
/
{instance}
:editexploratoryanalysis
Execute EditExploratoryAnalysis
curl --request POST \
  --url https://experiments.confidence.dev/v1/workflows/rollout/instances/{instance}:editexploratoryanalysis \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "parameters": {
    "id": "<string>",
    "conclusion": {
      "text": "<string>",
      "updateTime": "<string>"
    },
    "endTime": "<string>",
    "metrics": [
      {
        "dimensions": [
          {
            "column": "<string>"
          }
        ],
        "name": "<string>",
        "calculation": "<string>",
        "metricCalculation": "<string>",
        "scheduledCalculation": "<string>"
      }
    ],
    "name": "<string>",
    "startTime": "<string>"
  }
}
'
{
  "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
}

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

createTime
string
required

The create time

id
string
required

The analysis id

messages
string[]
required

Messages

metrics
object[]
required

The metrics to analyze

name
string
required

The analysis name

state
object
required

The analysis state

updateTime
string
required

The update time

analysisResults
object[]

Analysis results

conclusion
object

The conclusion

createdBy
string

A resource name on the format users/abc

endTime
string

The end time of the analysis time window

labels
object[]

Labels

splitByExposureFilters
boolean

Whether to split by exposure filters

startTime
string

The start time of the analysis time window

useCustomDateRange
boolean

Whether the analysis uses a custom date range

useScheduledCalculation
boolean

Use scheduled calculations instead of one-time calculations