Skip to main content

Common fields shared by all feature rule types. Specific rule types extend this base with their own required properties (value, coverage, etc.).

description
string
required
Maximum string length: 10000
id
string
required
enabled
boolean
required
type
string
required
Allowed value: "experiment"
condition
string
scheduleRules
object[]

Simple time-based on/off schedule for this rule

scheduleType
enum<string>

UI hint for which scheduling mode is active:

  • none – no schedule
  • schedule – simple time-based enable/disable via scheduleRules
  • ramp – multi-step ramp-up controlled by an associated RampSchedule document
Available options:
none,
schedule,
ramp
rampScheduleId
string

ID of the active RampSchedule document controlling this rule. Present when scheduleType is ramp and a live schedule exists.

savedGroupTargeting
object[]
prerequisites
object[]
trackingKey
string
hashAttribute
string
fallbackAttribute
string
disableStickyBucketing
boolean
bucketVersion
number
minBucketVersion
number
namespace
object
coverage
number
Required range: 0 <= x <= 1
value
object[]

Variation values with weights