Targeting rule (allocation) details for a feature flag environment.

Hierarchy

  • Allocation

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
createdAt: Date

The timestamp when the targeting rule allocation was created.

environmentIds: string[]

Environment IDs associated with this targeting rule allocation.

experimentId?: string

The experiment ID linked to this targeting rule allocation.

exposureSchedule?: AllocationExposureSchedule

Progressive release details for a targeting rule allocation.

guardrailMetrics: GuardrailMetric[]

Guardrail metrics associated with this targeting rule allocation.

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.

orderPosition: number

Sort order position within the environment.

targetingRules: TargetingRule[]

Conditions associated with this targeting rule allocation.

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

updatedAt: Date

The timestamp when the targeting rule allocation was last updated.

variantWeights: VariantWeight[]

Weighted variant assignments for this targeting rule allocation.

Generated using TypeDoc