Class ExperimentsReplaceExperimentProtocolRequestDataAttributes

Replace a published protocol template. Omitted optional template fields are cleared. Omitted enforcement and migration_metadata are preserved. Enabled limits require their values; allocation settings require environment_id.

Hierarchy

  • ExperimentsReplaceExperimentProtocolRequestDataAttributes

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

Statistical settings. Use default_duration_days for duration; target_duration_days is not accepted here.

Assignment properties.

assignmentSourceId?: string

ID of the assignment source selected by the protocol.

defaultDurationDays?: number

Default experiment duration supplied by the protocol, in days.

Complete lock map. Omit this object to preserve current locks. Null is rejected; every field is required.

environmentId?: string

ID of the feature flag environment used by the experiment.

Traffic schedule. Publishing and replacement require NO_ROLLOUT with exactly one step, or UNIFORM_INTERVALS with a positive selection interval and at least one step. Requires environment_id.

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.

metricLimit?: number

Maximum number of metrics allowed by the protocol.

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

Metadata for imported resources. Must encode to at most 4096 bytes. Null clears it; omission preserves it on update.

Type declaration

  • [key: string]: any
minimumDurationUnit?: string

Minimum duration unit, DAYS or WEEKS.

minimumDurationValue?: number

Minimum experiment duration in the specified unit.

primaryMetricId?: string

ID of the primary metric supplied by the protocol.

subjectTypeId: string

ID of the subject type used by this configuration.

Targeting rules.

Generated using TypeDoc