Optional additionalA container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.
Optional analysisPartial statistical settings. Omitted fields remain unchanged. Null clears the whole plan. Null clears nullable fields; null or an empty string clears confidence_interval_method.
Optional assignmentAssignment properties. Omission or null preserves them; an array replaces them.
Optional assignmentID of the assignment source selected by the protocol. Omission or null keeps the current value. An empty string clears it.
Optional defaultDefault experiment duration supplied by the protocol, in days. Omission preserves it; null clears it. Sets analysis_plan.target_duration_days on experiments created from this protocol.
Optional descriptionDescription. Empty string clears it; omission or null preserves it.
Optional enforcementPartial lock map. Omitted fields remain unchanged. Null clears the whole map. Empty or null field values become EDITABLE, except subject_type, flag_source, and confidence_interval_method, which remain LOCKED.
Optional environmentID of the feature flag environment used by the experiment. Omission or null keeps the current value. An empty string clears it.
Optional exposurePartial traffic schedule. Omitted fields remain unchanged. Null clears the whole schedule. Null clears nullable fields and rollout_steps; null sets strategy to an empty string and autostart to false.
Optional isWhether the protocol requires a duration before an experiment can start. Omission or null preserves it.
Optional isWhether the protocol requires equal traffic allocation across variants. Omission or null preserves it.
Optional isWhether the protocol limits the number of metrics. Omission or null preserves it.
Optional isWhether the protocol enforces a minimum experiment duration. Omission or null preserves it.
Optional metricMetric groups. Omission or null preserves them; an array replaces them.
Optional metricMaximum number of metrics allowed by the protocol. Omission preserves it; null clears it.
Optional migrationMetadata for imported resources. Must encode to at most 4096 bytes. Null clears it; omission preserves it on update.
Optional minimumMinimum duration unit, DAYS or WEEKS. Empty string clears it. Omission or null preserves it.
Optional minimumMinimum experiment duration in the specified unit. Omission preserves it; null clears it.
Optional nameProtocol name. Leading and trailing spaces are removed. The trimmed name must contain 1 to 255 characters.
Optional primaryID of the primary metric supplied by the protocol. Omission or null keeps the current value. An empty string clears it.
Optional subjectID of the subject type used by this configuration. Omission or null keeps the current value. An empty string clears it.
Optional targetingTargeting rules. Omission or null preserves them; an array replaces them.
Generated using TypeDoc
Partial protocol update. Omitted attributes remain unchanged. Published protocols accept only name, description, and migration_metadata; archived protocols reject updates.