Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The experiment id of the experiment to update

Body

application/json
triggeredBy
enum<string>

Set to "schedule" if you want this request to trigger notifications and other events as it if were a scheduled update. Defaults to manual.

Available options:
manual,
schedule
dimension
string

Dimension to break results down by. For Unit Dimensions, use the dimension id (e.g. "dim_abc123"). For Experiment Dimensions, use "exp:" (e.g. "exp:country"). Built-in pre-exposure dimensions include "pre:date" and, when configured, "pre:activation". Omit this field to create a standard snapshot.

phase
integer

Zero-based phase index to snapshot, where 0 is the first experiment phase. Defaults to the latest phase.

Required range: x >= 0

Response

200 - application/json

Resource created

snapshot
object
required