Class ExperimentsPublicProtocolResponseDataAttributes

Settings and defaults supplied by the protocol.

Hierarchy

  • ExperimentsPublicProtocolResponseDataAttributes

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Default statistical settings supplied by the protocol.

Default properties supplied by the protocol's assignment source.

assignmentSourceId?: string

ID of the assignment source selected by the protocol.

defaultDurationDays?: number

Default experiment duration supplied by the protocol, in days.

description?: string

Text that explains the protocol.

Controls that determine which protocol settings can be changed in an experiment.

environmentId?: string

ID of the feature flag environment used by the experiment.

Schedule that controls traffic exposure for experiments created from the protocol.

isDurationRequiredToStart: boolean

Whether the protocol requires a duration before an experiment can start.

isEqualSplitEnforced: boolean

Whether the protocol requires equal traffic allocation across variants.

isMetricLimitEnabled: boolean

Whether the protocol limits the number of metrics.

isMinimumDurationEnabled: boolean

Whether the protocol enforces a minimum experiment duration.

Metric groups supplied by the protocol.

metricLimit?: number

Maximum number of metrics allowed by the protocol.

migrationMetadata?: any

Metadata retained for resources imported from another system.

minimumDurationUnit?: string

Unit used to express the protocol's minimum duration.

minimumDurationValue?: number

Minimum experiment duration in the specified unit.

name: string

Display name of the protocol.

Subject type selected by the protocol.

primaryMetricId?: string

ID of the primary metric supplied by the protocol.

publishedAt?: Date

Time when the protocol was published.

Publication status of the protocol.

Subject type selected by the protocol.

subjectTypeId?: string

ID of the subject type used by this configuration.

Rules that select subjects for the experiment.

updatedAt: string

RFC3339 update time. Preserve all fractional seconds when passing this value as expected_updated_at.

Generated using TypeDoc