Request to create or update a targeting rule (allocation) for a feature flag environment.

Hierarchy

  • UpsertAllocationRequest

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
experimentId?: string

The experiment ID for experiment-linked allocations.

exposureSchedule?: ExposureScheduleRequest

Progressive release request payload.

guardrailMetrics?: GuardrailMetricRequest[]

Guardrail metrics used to monitor and auto-pause or abort.

id?: string

The unique identifier of the targeting rule allocation. Use this ID with the allocation management endpoints, such as /api/v2/allocations/{allocation_id}. It is not included in SDK evaluation results or exposure events.

key: string

The unique key of the targeting rule allocation. SDKs report this key in flag evaluation results and exposure events to indicate which targeting rule assigned the variant. Use it to match evaluation or experiment data to this rule.

name: string

The display name of the targeting rule.

targetingRules?: TargetingRuleRequest[]

Targeting rules that determine audience eligibility.

The type of targeting rule (called allocation in the API model).

variantWeights?: VariantWeightRequest[]

Variant distribution weights.

Generated using TypeDoc