Sign in

v2

latestOpenAPI 3.0.02026-08-073221853.1 MB
Experiments

Create Experiment Review

post/console/v1/experiments/{id}/reviews

Path parameters

idstring required

Request body

type'start' | 'stop' | 'pause' | 'restart' | 'abandon' | 'archive' | 'delete' | 'make_decision' | 'rollout' | 'schedule_rollout' | 'reallocate' | 'change_enabled_groups' | 'unarchive' | 'update_owners' | 'update_team' | 'update_settings' | 'update_overrides' | 'update_target_applications' | 'update_allowed_reviewers' | 'update_default_impact_multiplier' | 'scheduled_start' | 'scheduled_start_edit' | 'disable_reviews_locally' required

The kind of experiment change the review proposes.

descriptionstring

Human-readable description of the proposed change. Optional; recorded empty when omitted (e.g. update_owners, mirroring the console owner-edit flow, which collects no description).

reviewer_idsstring[]

User IDs to request review from.

reviewer_group_idsstring[]

Reviewer group IDs to request review from.

reasonstring

Optional reason recorded with the change, applied when committed (e.g. stop / pause / abandon / decision reason).

winning_group_idstring

For make_decision: the group to ship. Required.

remove_targetingboolean

For make_decision: drop targeting on ship (default false).

remove_overridesboolean

For make_decision: drop overrides on ship (default false).

start_datestring

For start: optional scheduled start date.

group_idstring

For rollout / schedule_rollout: the group to roll out. Required.

rollout_percentagenumber double

For rollout: the pass percentage to roll the group out to. Required.

clear_phasesboolean

For rollout: clear any scheduled rollout phases (default false).

enabled_group_namesstring[]

For change_enabled_groups: group names to enable.

disabled_group_namesstring[]

For change_enabled_groups: group names to disable.

team_idstring nullable

For update_team: the team to assign, or null to clear it.

default_impact_multipliernumber double

For update_default_impact_multiplier: the new multiplier. Required.

target_app_idsstring[]

For update_target_applications: the full set of target application IDs. Required.

allowed_reviewer_user_idsstring[]

For update_allowed_reviewers: the full set of allowed reviewer user IDs.

allowed_reviewer_group_idsstring[]

For update_allowed_reviewers: the full set of allowed reviewer group IDs.

start_timeinteger

For scheduled_start: epoch-ms time to schedule the start. Required.

new_timeinteger

For scheduled_start_edit: epoch-ms time to reschedule the start to. Required.

allow_overrides_in_pulseboolean

For update_overrides: whether overridden units are included in Pulse. Omit to preserve the current setting.

Response

The created experiment review.

messagestring required

A simple string explaining the result of the operation.