Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Experimentation Service

Auto-generated from /home/runner/work/feature-flag/feature-flag/proto/experiments/v1/experimentation_service.proto

Package: stitchd.experiments.v1

Enum: ExperimentStatus

ValueDescription
EXPERIMENT_STATUS_UNSPECIFIED
EXPERIMENT_STATUS_DRAFT
EXPERIMENT_STATUS_ACTIVE
EXPERIMENT_STATUS_PAUSED
EXPERIMENT_STATUS_CONCLUDED

Message: Experiment

FieldTypeDescription
idstring
environment_idstring
namestring
descriptionstring
flag_keystring
statusExperimentStatus
variant_keysrepeated string
created_at_msint64
updated_at_msint64
versionuint64

Message: ExperimentIteration

FieldTypeDescription
idstring
experiment_idstring
iteration_numberint32
started_at_msint64
ended_at_msint64Zero when the iteration is still running.
metric_keysrepeated string
traffic_allocationdouble

Message: VariantResult

FieldTypeDescription
variant_keystring
participant_countuint64
metric_valuesmap<string, double>
p_valuedouble
p_value_presentbool

Message: ExperimentResults

FieldTypeDescription
experiment_idstring
variant_resultsrepeated VariantResult
computed_at_msint64
is_stalebool
next_run_at_msint64
computation_statusstring

Message: CreateExperimentRequest

FieldTypeDescription
experimentExperiment

Message: UpdateExperimentRequest

FieldTypeDescription
experimentExperiment

Message: DeleteExperimentRequest

FieldTypeDescription
environment_idstring
experiment_idstring

Message: GetExperimentRequest

FieldTypeDescription
environment_idstring
experiment_idstring

Message: ListExperimentsRequest

FieldTypeDescription
environment_idstring

Message: ListExperimentsResponse

FieldTypeDescription
experimentsrepeated Experiment

Message: GetResultsRequest

FieldTypeDescription
environment_idstring
experiment_idstring

Message: TransitionExperimentRequest

FieldTypeDescription
environment_idstring
experiment_idstring
new_statusExperimentStatus
reasonstringHuman-readable reason for the transition (optional).

Message: ListIterationsRequest

FieldTypeDescription
environment_idstring
experiment_idstring

Message: ListIterationsResponse

FieldTypeDescription
iterationsrepeated ExperimentIteration

Service: ExperimentationService

CreateExperiment

  • Request: CreateExperimentRequest
  • Response: Experiment

GetExperiment

  • Request: GetExperimentRequest
  • Response: Experiment

ListExperiments

  • Request: ListExperimentsRequest
  • Response: ListExperimentsResponse

UpdateExperiment

  • Request: UpdateExperimentRequest
  • Response: Experiment

DeleteExperiment

  • Request: DeleteExperimentRequest
  • Response: Experiment

TransitionExperiment

  • Request: TransitionExperimentRequest
  • Response: Experiment

ListIterations

  • Request: ListIterationsRequest
  • Response: ListIterationsResponse

GetResults

  • Request: GetResultsRequest
  • Response: ExperimentResults