Skip to content

Latest commit

 

History

History
54 lines (48 loc) · 2.87 KB

IterationRep.md

File metadata and controls

54 lines (48 loc) · 2.87 KB

LaunchDarklyApi::IterationRep

Properties

Name Type Description Notes
_id String The iteration ID [optional]
hypothesis String The expected outcome of this experiment
status String The status of the iteration: <code>not_started</code>, <code>running</code>, <code>stopped</code>
created_at Integer
started_at Integer [optional]
ended_at Integer [optional]
winning_treatment_id String The ID of the treatment chosen when the experiment stopped [optional]
winning_reason String The reason you stopped the experiment [optional]
can_reshuffle_traffic Boolean Whether the experiment may reassign traffic to different variations when the experiment audience changes (true) or must keep all traffic assigned to its initial variation (false). [optional]
flags Hash<String, FlagRep> Details on the flag used in this experiment [optional]
primary_metric DependentMetricOrMetricGroupRep [optional]
primary_single_metric MetricV2Rep [optional]
primary_funnel DependentMetricGroupRepWithMetrics [optional]
randomization_unit String The unit of randomization for this iteration [optional]
attributes Array<String> The available attribute filters for this iteration [optional]
treatments Array<TreatmentRep> Details on the variations you are testing in the experiment [optional]
secondary_metrics Array<MetricV2Rep> Deprecated, use <code>metrics</code> instead. Details on the secondary metrics for this experiment. [optional]
metrics Array<DependentMetricOrMetricGroupRep> Details on the metrics for this experiment [optional]
layer_snapshot LayerSnapshotRep [optional]

Example

require 'launchdarkly_api'

instance = LaunchDarklyApi::IterationRep.new(
  _id: 12ab3c45de678910fgh12345,
  hypothesis: The new button placement will increase conversion,
  status: running,
  created_at: null,
  started_at: null,
  ended_at: null,
  winning_treatment_id: 122c9f3e-da26-4321-ba68-e0fc02eced58,
  winning_reason: We ran this iteration for two weeks and the winning variation was clear,
  can_reshuffle_traffic: true,
  flags: null,
  primary_metric: null,
  primary_single_metric: null,
  primary_funnel: null,
  randomization_unit: user,
  attributes: null,
  treatments: null,
  secondary_metrics: null,
  metrics: null,
  layer_snapshot: null
)