Update Experiment

patchhttps://d1iwal3igywepk.cloudfront.net/experiments/{id}

Updates any non-empty subset of four fields:

name and description: on any status.
cap_days: only while running; at least the current value and at most twice the metric's catalog cap. Queues a recompute.
changed_at: only while starting or running and within 7 days of the current change date; a past date at most 30 days before the recorded change. Queues a recompute.

Every field is checked before any is written: one failing rule fails the whole request (400 for a value out of range, 409 experiment_invalid_state for a status rule). Metric, scope, prediction and the insight link cannot change: create a new experiment instead.

Requires the insights:write scope; read:* does not grant it.

Authorization

AuthorizationBearer <token>

API key as Bearer token

In: header

Path Parameters

id*string

Request Body

application/json

name?string

Length1 <= length <= 200

description?string

Lengthlength <= 2000

cap_days?integer

Range1 <= value

changed_at?string

Formatdate-time

Responses

The updated experiment

id*string

Formatuuid

name*string|null

description*string|null

source*ExperimentSource

Value in

"insight"
"ads_proposal"
"api"

insight_id*string|null

ads_platform*string|null

ads_proposal_id*string|null

kind*ExperimentKind

Value in

"landing_page"
"ad_campaign"
"ad_budget"

method*"before_after"

Value in

"before_after"

metric_key*string

scope*

fix_type*string|null

status*ExperimentStatus

Value in

"starting"
"running"
"closed"
"stopped"
"cancelled"

cancel_reason*string|null

verdict*string|null

evidence_grade*|

Value in

"A"
"B"
"C"
null

changed_at*string

changed_at_source*string

est_end_at*string|null

baseline_days*number|null

floor_days*number|null

cap_days*number|null

predicted_improvement_low_pct*number|null

predicted_improvement_high_pct*number|null

predicted_spend_change_pct*number|null

predicted_money_low_cents*number|null

predicted_money_high_cents*number|null

predicted_money_currency*string|null

stop_requested_at*string|null

refresh_requested_at*string|null

closed_at*string|null

created_at*string

updated_at*string

changed_via*string

snapshot*|null

patch/experiments/{id}

curl -X PATCH "https://d1iwal3igywepk.cloudfront.net/experiments/string" \  -H "Content-Type: application/json" \  -d '{}'

Example Request Body

json

{}

Example Responses

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "source": "insight",  "insight_id": "string",  "ads_platform": "string",  "ads_proposal_id": "string",  "kind": "landing_page",  "method": "before_after",  "metric_key": "string",  "scope": {},  "fix_type": "string",  "status": "starting",  "cancel_reason": "string",  "verdict": "string",  "evidence_grade": "A",  "changed_at": "string",  "changed_at_source": "string",  "est_end_at": "string",  "baseline_days": 0,  "floor_days": 0,  "cap_days": 0,  "predicted_improvement_low_pct": 0,  "predicted_improvement_high_pct": 0,  "predicted_spend_change_pct": 0,  "predicted_money_low_cents": 0,  "predicted_money_high_cents": 0,  "predicted_money_currency": "string",  "stop_requested_at": "string",  "refresh_requested_at": "string",  "closed_at": "string",  "created_at": "string",  "updated_at": "string",  "changed_via": "string",  "snapshot": {    "computed_at": "string",    "verdict": "string",    "effect": {      "estimate_pct": 0,      "ci_low_pct": 0,      "ci_high_pct": 0,      "undefined_reason": "string",      "spend_change_pct": 0    },    "money": {      "estimate_cents": 0,      "low_cents": 0,      "high_cents": 0,      "currency": "string"    },    "sample": {      "pre_days": 0,      "post_days": 0,      "required_post_days": 0,      "phi": 0    },    "placebo": {      "estimate_pct": 0,      "ci_low_pct": 0,      "ci_high_pct": 0,      "failed": true    },    "series": [      {        "date": "string",        "target_num": 0,        "target_den": 0,        "control_num": 0,        "control_den": 0,        "settled": true      }    ]  }}

application/json