Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

If using Bearer auth, pass the Secret Key as the token:

Path Parameters

id
string
required

The id of the requested resource

Body

application/json
statsEngine
enum<string>

Stats engine override

Available options:
bayesian,
frequentist
goalMetrics
string[]

Goal metric IDs

secondaryMetrics
string[]

Secondary metric IDs

guardrailMetrics
string[]

Guardrail metric IDs

activationMetric
string

Activation metric ID

metricOverrides
object[]

Per-metric window, risk, and regression-adjustment overrides

customMetricSlices
object[]

Custom metric slice definitions

dimension
string

Dimension to cut results by

differenceType
enum<string>

How lifts are expressed in results

Available options:
relative,
absolute,
scaled
dateStarted
string<date-time>

Analysis start date (ISO 8601)

dateEnded
string<date-time> | null

Analysis end date (ISO 8601). Pass null to clear the end date and analyze through today.

regressionAdjustmentEnabled
boolean

Enable CUPED regression adjustment

sequentialTestingEnabled
boolean

Enable sequential testing

sequentialTestingTuningParameter
number

Tuning parameter for sequential testing (frequentist only)

attributionModel
enum<string>

Metric conversion window attribution model

Available options:
firstExposure,
experimentDuration,
lookbackOverride
lookbackOverride
object

Lookback window when attributionModel is lookbackOverride

segment
string

Segment ID to filter users by

queryFilter
string

Raw SQL WHERE clause added to the exposure query

skipPartialData
boolean

When true, exclude users who have not completed the full conversion window

variations
object[]

Override variation names, keys, or traffic weights used in this report. Weights are merged into the latest phase. Changes take effect on the next refresh.

coverage
number

Traffic coverage (0–1) for the latest phase. Used when computing scaled impact.

Required range: 0 <= x <= 1

Response

200 - application/json

Resource updated

report
object
required