IterationRep.md

IterationRep

Properties

Name	Type	Description	Notes
_id	string	The iteration ID	[optional] [default to undefined]
hypothesis	string	The expected outcome of this experiment	[default to undefined]
status	string	The status of the iteration: <code>not_started</code>, <code>running</code>, <code>stopped</code>	[default to undefined]
createdAt	number		[default to undefined]
startedAt	number		[optional] [default to undefined]
endedAt	number		[optional] [default to undefined]
winningTreatmentId	string	The ID of the treatment chosen when the experiment stopped	[optional] [default to undefined]
winningReason	string	The reason you stopped the experiment	[optional] [default to undefined]
canReshuffleTraffic	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] [default to undefined]
flags	{ [key: string]: FlagRep; }	Details on the flag used in this experiment	[optional] [default to undefined]
reallocationFrequencyMillis	number	The cadence (in milliseconds) to update the allocation. Only present for multi-armed bandits.	[optional] [default to undefined]
version	number	The current version that the iteration is on	[optional] [default to undefined]
primaryMetric	DependentMetricOrMetricGroupRep		[optional] [default to undefined]
primarySingleMetric	MetricV2Rep		[optional] [default to undefined]
primaryFunnel	DependentMetricGroupRepWithMetrics		[optional] [default to undefined]
randomizationUnit	string	The unit of randomization for this iteration	[optional] [default to undefined]
attributes	Array<string>	The available attribute filters for this iteration	[optional] [default to undefined]
treatments	Array<TreatmentRep>	Details on the variations you are testing in the experiment	[optional] [default to undefined]
secondaryMetrics	Array<MetricV2Rep>	Deprecated, use <code>metrics</code> instead. Details on the secondary metrics for this experiment.	[optional] [default to undefined]
metrics	Array<DependentMetricOrMetricGroupRep>	Details on the metrics for this experiment	[optional] [default to undefined]
layerSnapshot	LayerSnapshotRep		[optional] [default to undefined]

Example

import { IterationRep } from 'launchdarkly-api-typescript';

const instance: IterationRep = {
    _id,
    hypothesis,
    status,
    createdAt,
    startedAt,
    endedAt,
    winningTreatmentId,
    winningReason,
    canReshuffleTraffic,
    flags,
    reallocationFrequencyMillis,
    version,
    primaryMetric,
    primarySingleMetric,
    primaryFunnel,
    randomizationUnit,
    attributes,
    treatments,
    secondaryMetrics,
    metrics,
    layerSnapshot,
};

[Back to Model list] [Back to API list] [Back to README]