From 6900e9121da7850a6115193d7b64c828e4450be6 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Tue, 9 Jun 2026 01:25:00 +0000 Subject: [PATCH] Regenerate client from commit 302b39c of spec repo --- content/en/api/v2/feature-flags/examples.json | 36 +++++++---------- data/api/v2/full_spec.yaml | 40 +++++++++++++------ 2 files changed, 41 insertions(+), 35 deletions(-) diff --git a/content/en/api/v2/feature-flags/examples.json b/content/en/api/v2/feature-flags/examples.json index 4e8eaa5fe0e..096d2d6925e 100644 --- a/content/en/api/v2/feature-flags/examples.json +++ b/content/en/api/v2/feature-flags/examples.json @@ -1280,6 +1280,7 @@ "created_at": "2024-01-01T12:00:00Z", "id": "550e8400-e29b-41d4-a716-446655440070", "operator": "ONE_OF", + "saved_filter_id": "550e8400-e29b-41d4-a716-446655440090", "updated_at": "2024-01-01T12:00:00Z", "value": [ "US", @@ -1316,7 +1317,7 @@ "type": "allocations" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data wrapper for targeting rule allocation responses.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule allocation was created.

\n
\n \n
\n
\n
\n
\n
\n

environment_ids [required]

\n
\n

[string]

\n

Environment IDs associated with this targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

experiment_id

\n
\n

string

\n

The experiment ID linked to this targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

exposure_schedule

\n
\n

object

\n

Progressive release details for a targeting rule allocation.

\n
\n
\n
\n
\n
\n

absolute_start_time

\n
\n

date-time

\n

The absolute UTC start time for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

allocation_id [required]

\n
\n

uuid

\n

The targeting rule allocation ID this progressive rollout belongs to.

\n
\n \n
\n
\n
\n
\n
\n

control_variant_id

\n
\n

string

\n

The control variant ID used for experiment comparisons.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the schedule was created.

\n
\n \n
\n
\n
\n
\n
\n

guardrail_triggered_action

\n
\n

string

\n

Last guardrail action triggered for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

guardrail_triggers [required]

\n
\n

[object]

\n

Guardrail trigger records for this schedule.

\n
\n
\n
\n
\n
\n

allocation_exposure_schedule_id [required]

\n
\n

uuid

\n

The progressive rollout ID this trigger belongs to.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when this trigger was created.

\n
\n \n
\n
\n
\n
\n
\n

flagging_variant_id [required]

\n
\n

uuid

\n

The variant ID that triggered this event.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the guardrail trigger.

\n
\n \n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID associated with the trigger.

\n
\n \n
\n
\n
\n
\n
\n

triggered_action [required]

\n
\n

string

\n

The action that was triggered.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when this trigger was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the progressive rollout.

\n
\n \n
\n
\n
\n
\n
\n

rollout_options [required]

\n
\n

object

\n

Applied progression options for a progressive rollout.

\n
\n
\n
\n
\n
\n

autostart [required]

\n
\n

boolean

\n

Whether the schedule starts automatically.

\n
\n \n
\n
\n
\n
\n
\n

selection_interval_ms [required]

\n
\n

int64

\n

Interval in milliseconds for uniform interval strategies.

\n
\n \n
\n
\n
\n
\n
\n

strategy [required]

\n
\n

enum

\n

The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rollout_steps [required]

\n
\n

[object]

\n

Ordered progression steps for exposure.

\n
\n
\n
\n
\n
\n

allocation_exposure_schedule_id [required]

\n
\n

uuid

\n

The progressive rollout ID this step belongs to.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the progression step was created.

\n
\n \n
\n
\n
\n
\n
\n

exposure_ratio [required]

\n
\n

double

\n

The exposure ratio for this step.

\n
\n \n
\n
\n
\n
\n
\n

grouped_step_index [required]

\n
\n

int64

\n

Logical index grouping related steps.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the progression step.

\n
\n \n
\n
\n
\n
\n
\n

interval_ms

\n
\n

int64

\n

Step duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

is_pause_record [required]

\n
\n

boolean

\n

Whether this step represents a pause record.

\n
\n \n
\n
\n
\n
\n
\n

order_position [required]

\n
\n

int64

\n

Sort order for the progression step.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the progression step was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the schedule was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

guardrail_metrics [required]

\n
\n

[object]

\n

Guardrail metrics associated with this targeting rule allocation.

\n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID to monitor.

\n
\n \n
\n
\n
\n
\n
\n

trigger_action [required]

\n
\n

enum

\n

Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT

\n
\n \n
\n
\n
\n
\n
\n

triggered_by

\n
\n

string

\n

The signal or system that triggered the action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

order_position [required]

\n
\n

int64

\n

Sort order position within the environment.

\n
\n \n
\n
\n
\n
\n
\n

targeting_rules [required]

\n
\n

[object]

\n

Conditions associated with this targeting rule allocation.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions evaluated by this targeting rule.

\n
\n
\n
\n
\n
\n

attribute [required]

\n
\n

string

\n

The user or request attribute to evaluate.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the condition was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the condition.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the condition was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

[string]

\n

Values used by the selected operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule allocation was last updated.

\n
\n \n
\n
\n
\n
\n
\n

variant_weights [required]

\n
\n

[object]

\n

Weighted variant assignments for this targeting rule allocation.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The timestamp when the variant weight was created.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Unique identifier of the variant weight assignment.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The timestamp when the variant weight was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

double

\n

The percentage weight for the variant.

\n
\n \n
\n
\n
\n
\n
\n

variant

\n
\n

object

\n

A variant of a feature flag.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The timestamp when the variant was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the variant.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the variant.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the variant.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The timestamp when the variant was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The value of the variant as a string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

variant_id [required]

\n
\n

uuid

\n

The variant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type. \nAllowed enum values: allocations

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data wrapper for targeting rule allocation responses.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule allocation was created.

\n
\n \n
\n
\n
\n
\n
\n

environment_ids [required]

\n
\n

[string]

\n

Environment IDs associated with this targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

experiment_id

\n
\n

string

\n

The experiment ID linked to this targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

exposure_schedule

\n
\n

object

\n

Progressive release details for a targeting rule allocation.

\n
\n
\n
\n
\n
\n

absolute_start_time

\n
\n

date-time

\n

The absolute UTC start time for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

allocation_id [required]

\n
\n

uuid

\n

The targeting rule allocation ID this progressive rollout belongs to.

\n
\n \n
\n
\n
\n
\n
\n

control_variant_id

\n
\n

string

\n

The control variant ID used for experiment comparisons.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the schedule was created.

\n
\n \n
\n
\n
\n
\n
\n

guardrail_triggered_action

\n
\n

string

\n

Last guardrail action triggered for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

guardrail_triggers [required]

\n
\n

[object]

\n

Guardrail trigger records for this schedule.

\n
\n
\n
\n
\n
\n

allocation_exposure_schedule_id [required]

\n
\n

uuid

\n

The progressive rollout ID this trigger belongs to.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when this trigger was created.

\n
\n \n
\n
\n
\n
\n
\n

flagging_variant_id [required]

\n
\n

uuid

\n

The variant ID that triggered this event.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the guardrail trigger.

\n
\n \n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID associated with the trigger.

\n
\n \n
\n
\n
\n
\n
\n

triggered_action [required]

\n
\n

string

\n

The action that was triggered.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when this trigger was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the progressive rollout.

\n
\n \n
\n
\n
\n
\n
\n

rollout_options [required]

\n
\n

object

\n

Applied progression options for a progressive rollout.

\n
\n
\n
\n
\n
\n

autostart [required]

\n
\n

boolean

\n

Whether the schedule starts automatically.

\n
\n \n
\n
\n
\n
\n
\n

selection_interval_ms [required]

\n
\n

int64

\n

Interval in milliseconds for uniform interval strategies.

\n
\n \n
\n
\n
\n
\n
\n

strategy [required]

\n
\n

enum

\n

The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rollout_steps [required]

\n
\n

[object]

\n

Ordered progression steps for exposure.

\n
\n
\n
\n
\n
\n

allocation_exposure_schedule_id [required]

\n
\n

uuid

\n

The progressive rollout ID this step belongs to.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the progression step was created.

\n
\n \n
\n
\n
\n
\n
\n

exposure_ratio [required]

\n
\n

double

\n

The exposure ratio for this step.

\n
\n \n
\n
\n
\n
\n
\n

grouped_step_index [required]

\n
\n

int64

\n

Logical index grouping related steps.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the progression step.

\n
\n \n
\n
\n
\n
\n
\n

interval_ms

\n
\n

int64

\n

Step duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

is_pause_record [required]

\n
\n

boolean

\n

Whether this step represents a pause record.

\n
\n \n
\n
\n
\n
\n
\n

order_position [required]

\n
\n

int64

\n

Sort order for the progression step.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the progression step was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the schedule was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

guardrail_metrics [required]

\n
\n

[object]

\n

Guardrail metrics associated with this targeting rule allocation.

\n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID to monitor.

\n
\n \n
\n
\n
\n
\n
\n

trigger_action [required]

\n
\n

enum

\n

Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT

\n
\n \n
\n
\n
\n
\n
\n

triggered_by

\n
\n

string

\n

The signal or system that triggered the action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

order_position [required]

\n
\n

int64

\n

Sort order position within the environment.

\n
\n \n
\n
\n
\n
\n
\n

targeting_rules [required]

\n
\n

[object]

\n

Conditions associated with this targeting rule allocation.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions evaluated by this targeting rule.

\n
\n
\n
\n
\n
\n

attribute

\n
\n

string

\n

The user or request attribute to evaluate. Omitted for saved-filter references.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the condition was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the condition.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

enum

\n

The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS

\n
\n \n
\n
\n
\n
\n
\n

saved_filter_id

\n
\n

uuid

\n

The ID of the saved filter referenced by this condition, or null for inline conditions.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the condition was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

Values used by the selected operator. Omitted for saved-filter references.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule allocation was last updated.

\n
\n \n
\n
\n
\n
\n
\n

variant_weights [required]

\n
\n

[object]

\n

Weighted variant assignments for this targeting rule allocation.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The timestamp when the variant weight was created.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Unique identifier of the variant weight assignment.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The timestamp when the variant weight was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

double

\n

The percentage weight for the variant.

\n
\n \n
\n
\n
\n
\n
\n

variant

\n
\n

object

\n

A variant of a feature flag.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The timestamp when the variant was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the variant.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the variant.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the variant.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The timestamp when the variant was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The value of the variant as a string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

variant_id [required]

\n
\n

uuid

\n

The variant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type. \nAllowed enum values: allocations

\n
\n \n
\n
\n
\n
" }, "202": { "json": { @@ -1384,6 +1385,7 @@ "created_at": "2024-01-01T12:00:00Z", "id": "550e8400-e29b-41d4-a716-446655440070", "operator": "ONE_OF", + "saved_filter_id": "550e8400-e29b-41d4-a716-446655440090", "updated_at": "2024-01-01T12:00:00Z", "value": [ "US", @@ -1420,7 +1422,7 @@ "type": "allocations" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data wrapper for targeting rule allocation responses.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule allocation was created.

\n
\n \n
\n
\n
\n
\n
\n

environment_ids [required]

\n
\n

[string]

\n

Environment IDs associated with this targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

experiment_id

\n
\n

string

\n

The experiment ID linked to this targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

exposure_schedule

\n
\n

object

\n

Progressive release details for a targeting rule allocation.

\n
\n
\n
\n
\n
\n

absolute_start_time

\n
\n

date-time

\n

The absolute UTC start time for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

allocation_id [required]

\n
\n

uuid

\n

The targeting rule allocation ID this progressive rollout belongs to.

\n
\n \n
\n
\n
\n
\n
\n

control_variant_id

\n
\n

string

\n

The control variant ID used for experiment comparisons.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the schedule was created.

\n
\n \n
\n
\n
\n
\n
\n

guardrail_triggered_action

\n
\n

string

\n

Last guardrail action triggered for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

guardrail_triggers [required]

\n
\n

[object]

\n

Guardrail trigger records for this schedule.

\n
\n
\n
\n
\n
\n

allocation_exposure_schedule_id [required]

\n
\n

uuid

\n

The progressive rollout ID this trigger belongs to.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when this trigger was created.

\n
\n \n
\n
\n
\n
\n
\n

flagging_variant_id [required]

\n
\n

uuid

\n

The variant ID that triggered this event.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the guardrail trigger.

\n
\n \n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID associated with the trigger.

\n
\n \n
\n
\n
\n
\n
\n

triggered_action [required]

\n
\n

string

\n

The action that was triggered.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when this trigger was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the progressive rollout.

\n
\n \n
\n
\n
\n
\n
\n

rollout_options [required]

\n
\n

object

\n

Applied progression options for a progressive rollout.

\n
\n
\n
\n
\n
\n

autostart [required]

\n
\n

boolean

\n

Whether the schedule starts automatically.

\n
\n \n
\n
\n
\n
\n
\n

selection_interval_ms [required]

\n
\n

int64

\n

Interval in milliseconds for uniform interval strategies.

\n
\n \n
\n
\n
\n
\n
\n

strategy [required]

\n
\n

enum

\n

The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rollout_steps [required]

\n
\n

[object]

\n

Ordered progression steps for exposure.

\n
\n
\n
\n
\n
\n

allocation_exposure_schedule_id [required]

\n
\n

uuid

\n

The progressive rollout ID this step belongs to.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the progression step was created.

\n
\n \n
\n
\n
\n
\n
\n

exposure_ratio [required]

\n
\n

double

\n

The exposure ratio for this step.

\n
\n \n
\n
\n
\n
\n
\n

grouped_step_index [required]

\n
\n

int64

\n

Logical index grouping related steps.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the progression step.

\n
\n \n
\n
\n
\n
\n
\n

interval_ms

\n
\n

int64

\n

Step duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

is_pause_record [required]

\n
\n

boolean

\n

Whether this step represents a pause record.

\n
\n \n
\n
\n
\n
\n
\n

order_position [required]

\n
\n

int64

\n

Sort order for the progression step.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the progression step was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the schedule was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

guardrail_metrics [required]

\n
\n

[object]

\n

Guardrail metrics associated with this targeting rule allocation.

\n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID to monitor.

\n
\n \n
\n
\n
\n
\n
\n

trigger_action [required]

\n
\n

enum

\n

Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT

\n
\n \n
\n
\n
\n
\n
\n

triggered_by

\n
\n

string

\n

The signal or system that triggered the action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

order_position [required]

\n
\n

int64

\n

Sort order position within the environment.

\n
\n \n
\n
\n
\n
\n
\n

targeting_rules [required]

\n
\n

[object]

\n

Conditions associated with this targeting rule allocation.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions evaluated by this targeting rule.

\n
\n
\n
\n
\n
\n

attribute [required]

\n
\n

string

\n

The user or request attribute to evaluate.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the condition was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the condition.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the condition was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

[string]

\n

Values used by the selected operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule allocation was last updated.

\n
\n \n
\n
\n
\n
\n
\n

variant_weights [required]

\n
\n

[object]

\n

Weighted variant assignments for this targeting rule allocation.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The timestamp when the variant weight was created.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Unique identifier of the variant weight assignment.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The timestamp when the variant weight was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

double

\n

The percentage weight for the variant.

\n
\n \n
\n
\n
\n
\n
\n

variant

\n
\n

object

\n

A variant of a feature flag.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The timestamp when the variant was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the variant.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the variant.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the variant.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The timestamp when the variant was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The value of the variant as a string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

variant_id [required]

\n
\n

uuid

\n

The variant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type. \nAllowed enum values: allocations

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data wrapper for targeting rule allocation responses.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule allocation was created.

\n
\n \n
\n
\n
\n
\n
\n

environment_ids [required]

\n
\n

[string]

\n

Environment IDs associated with this targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

experiment_id

\n
\n

string

\n

The experiment ID linked to this targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

exposure_schedule

\n
\n

object

\n

Progressive release details for a targeting rule allocation.

\n
\n
\n
\n
\n
\n

absolute_start_time

\n
\n

date-time

\n

The absolute UTC start time for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

allocation_id [required]

\n
\n

uuid

\n

The targeting rule allocation ID this progressive rollout belongs to.

\n
\n \n
\n
\n
\n
\n
\n

control_variant_id

\n
\n

string

\n

The control variant ID used for experiment comparisons.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the schedule was created.

\n
\n \n
\n
\n
\n
\n
\n

guardrail_triggered_action

\n
\n

string

\n

Last guardrail action triggered for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

guardrail_triggers [required]

\n
\n

[object]

\n

Guardrail trigger records for this schedule.

\n
\n
\n
\n
\n
\n

allocation_exposure_schedule_id [required]

\n
\n

uuid

\n

The progressive rollout ID this trigger belongs to.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when this trigger was created.

\n
\n \n
\n
\n
\n
\n
\n

flagging_variant_id [required]

\n
\n

uuid

\n

The variant ID that triggered this event.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the guardrail trigger.

\n
\n \n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID associated with the trigger.

\n
\n \n
\n
\n
\n
\n
\n

triggered_action [required]

\n
\n

string

\n

The action that was triggered.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when this trigger was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the progressive rollout.

\n
\n \n
\n
\n
\n
\n
\n

rollout_options [required]

\n
\n

object

\n

Applied progression options for a progressive rollout.

\n
\n
\n
\n
\n
\n

autostart [required]

\n
\n

boolean

\n

Whether the schedule starts automatically.

\n
\n \n
\n
\n
\n
\n
\n

selection_interval_ms [required]

\n
\n

int64

\n

Interval in milliseconds for uniform interval strategies.

\n
\n \n
\n
\n
\n
\n
\n

strategy [required]

\n
\n

enum

\n

The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rollout_steps [required]

\n
\n

[object]

\n

Ordered progression steps for exposure.

\n
\n
\n
\n
\n
\n

allocation_exposure_schedule_id [required]

\n
\n

uuid

\n

The progressive rollout ID this step belongs to.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the progression step was created.

\n
\n \n
\n
\n
\n
\n
\n

exposure_ratio [required]

\n
\n

double

\n

The exposure ratio for this step.

\n
\n \n
\n
\n
\n
\n
\n

grouped_step_index [required]

\n
\n

int64

\n

Logical index grouping related steps.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the progression step.

\n
\n \n
\n
\n
\n
\n
\n

interval_ms

\n
\n

int64

\n

Step duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

is_pause_record [required]

\n
\n

boolean

\n

Whether this step represents a pause record.

\n
\n \n
\n
\n
\n
\n
\n

order_position [required]

\n
\n

int64

\n

Sort order for the progression step.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the progression step was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the schedule was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

guardrail_metrics [required]

\n
\n

[object]

\n

Guardrail metrics associated with this targeting rule allocation.

\n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID to monitor.

\n
\n \n
\n
\n
\n
\n
\n

trigger_action [required]

\n
\n

enum

\n

Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT

\n
\n \n
\n
\n
\n
\n
\n

triggered_by

\n
\n

string

\n

The signal or system that triggered the action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

order_position [required]

\n
\n

int64

\n

Sort order position within the environment.

\n
\n \n
\n
\n
\n
\n
\n

targeting_rules [required]

\n
\n

[object]

\n

Conditions associated with this targeting rule allocation.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions evaluated by this targeting rule.

\n
\n
\n
\n
\n
\n

attribute

\n
\n

string

\n

The user or request attribute to evaluate. Omitted for saved-filter references.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the condition was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the condition.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

enum

\n

The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS

\n
\n \n
\n
\n
\n
\n
\n

saved_filter_id

\n
\n

uuid

\n

The ID of the saved filter referenced by this condition, or null for inline conditions.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the condition was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

Values used by the selected operator. Omitted for saved-filter references.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule allocation was last updated.

\n
\n \n
\n
\n
\n
\n
\n

variant_weights [required]

\n
\n

[object]

\n

Weighted variant assignments for this targeting rule allocation.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The timestamp when the variant weight was created.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Unique identifier of the variant weight assignment.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The timestamp when the variant weight was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

double

\n

The percentage weight for the variant.

\n
\n \n
\n
\n
\n
\n
\n

variant

\n
\n

object

\n

A variant of a feature flag.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The timestamp when the variant was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the variant.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the variant.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the variant.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The timestamp when the variant was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The value of the variant as a string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

variant_id [required]

\n
\n

uuid

\n

The variant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type. \nAllowed enum values: allocations

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1490,14 +1492,7 @@ "targeting_rules": [ { "conditions": [ - { - "attribute": "user_tier", - "operator": "ONE_OF", - "value": [ - "premium", - "enterprise" - ] - } + {} ] } ], @@ -1550,6 +1545,7 @@ { "attribute": "user_tier", "operator": "ONE_OF", + "saved_filter_id": "550e8400-e29b-41d4-a716-446655440090", "value": [ "premium", "enterprise" @@ -1570,7 +1566,7 @@ "type": "allocations" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data wrapper for allocation request payloads.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

experiment_id

\n
\n

string

\n

The experiment ID for experiment-linked allocations.

\n
\n \n
\n
\n
\n
\n
\n

exposure_schedule

\n
\n

object

\n

Progressive release request payload.

\n
\n
\n
\n
\n
\n

absolute_start_time

\n
\n

date-time

\n

The absolute UTC start time for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

control_variant_id

\n
\n

string

\n

The control variant ID used for experiment comparisons.

\n
\n \n
\n
\n
\n
\n
\n

control_variant_key

\n
\n

string

\n

The control variant key used during creation workflows.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the progressive rollout.

\n
\n \n
\n
\n
\n
\n
\n

rollout_options [required]

\n
\n

object

\n

Rollout options request payload.

\n
\n
\n
\n
\n
\n

autostart

\n
\n

boolean

\n

Whether the schedule should begin automatically.

\n
\n \n
\n
\n
\n
\n
\n

selection_interval_ms

\n
\n

int64

\n

Interval in milliseconds for uniform interval strategies.

\n
\n \n
\n
\n
\n
\n
\n

strategy [required]

\n
\n

enum

\n

The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rollout_steps [required]

\n
\n

[object]

\n

Ordered progression steps for exposure.

\n
\n
\n
\n
\n
\n

exposure_ratio [required]

\n
\n

double

\n

The exposure ratio for this step.

\n
\n \n
\n
\n
\n
\n
\n

grouped_step_index [required]

\n
\n

int64

\n

Logical index grouping related steps.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the progression step.

\n
\n \n
\n
\n
\n
\n
\n

interval_ms

\n
\n

int64

\n

Step duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

is_pause_record [required]

\n
\n

boolean

\n

Whether this step represents a pause record.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

guardrail_metrics

\n
\n

[object]

\n

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

\n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID to monitor.

\n
\n \n
\n
\n
\n
\n
\n

trigger_action [required]

\n
\n

enum

\n

Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

targeting_rules

\n
\n

[object]

\n

Targeting rules that determine audience eligibility.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions that must match for this rule.

\n
\n
\n
\n
\n
\n

attribute [required]

\n
\n

string

\n

The user or request attribute to evaluate.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

[string]

\n

Values used by the selected operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY

\n
\n \n
\n
\n
\n
\n
\n

variant_weights

\n
\n

[object]

\n

Variant distribution weights.

\n
\n
\n
\n
\n
\n

value [required]

\n
\n

double

\n

The percentage weight for this variant.

\n
\n \n
\n
\n
\n
\n
\n

variant_id

\n
\n

uuid

\n

The variant ID to assign weight to.

\n
\n \n
\n
\n
\n
\n
\n

variant_key

\n
\n

string

\n

The variant key to assign weight to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type. \nAllowed enum values: allocations

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data wrapper for allocation request payloads.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

experiment_id

\n
\n

string

\n

The experiment ID for experiment-linked allocations.

\n
\n \n
\n
\n
\n
\n
\n

exposure_schedule

\n
\n

object

\n

Progressive release request payload.

\n
\n
\n
\n
\n
\n

absolute_start_time

\n
\n

date-time

\n

The absolute UTC start time for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

control_variant_id

\n
\n

string

\n

The control variant ID used for experiment comparisons.

\n
\n \n
\n
\n
\n
\n
\n

control_variant_key

\n
\n

string

\n

The control variant key used during creation workflows.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the progressive rollout.

\n
\n \n
\n
\n
\n
\n
\n

rollout_options [required]

\n
\n

object

\n

Rollout options request payload.

\n
\n
\n
\n
\n
\n

autostart

\n
\n

boolean

\n

Whether the schedule should begin automatically.

\n
\n \n
\n
\n
\n
\n
\n

selection_interval_ms

\n
\n

int64

\n

Interval in milliseconds for uniform interval strategies.

\n
\n \n
\n
\n
\n
\n
\n

strategy [required]

\n
\n

enum

\n

The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rollout_steps [required]

\n
\n

[object]

\n

Ordered progression steps for exposure.

\n
\n
\n
\n
\n
\n

exposure_ratio [required]

\n
\n

double

\n

The exposure ratio for this step.

\n
\n \n
\n
\n
\n
\n
\n

grouped_step_index [required]

\n
\n

int64

\n

Logical index grouping related steps.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the progression step.

\n
\n \n
\n
\n
\n
\n
\n

interval_ms

\n
\n

int64

\n

Step duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

is_pause_record [required]

\n
\n

boolean

\n

Whether this step represents a pause record.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

guardrail_metrics

\n
\n

[object]

\n

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

\n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID to monitor.

\n
\n \n
\n
\n
\n
\n
\n

trigger_action [required]

\n
\n

enum

\n

Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

targeting_rules

\n
\n

[object]

\n

Targeting rules that determine audience eligibility.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions that must match for this rule.

\n
\n
\n
\n
\n
\n

attribute

\n
\n

string

\n

The user or request attribute to evaluate. Required for inline conditions; omit when saved_filter_id is set.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

enum

\n

The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS

\n
\n \n
\n
\n
\n
\n
\n

saved_filter_id

\n
\n

uuid

\n

The ID of a saved filter to reference as this condition. Mutually exclusive\nwith operator, attribute, and value. When set, the saved filter's\ntargeting rules are evaluated in place of an inline predicate.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

Values used by the selected operator. Required for inline conditions; omit when saved_filter_id is set.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY

\n
\n \n
\n
\n
\n
\n
\n

variant_weights

\n
\n

[object]

\n

Variant distribution weights.

\n
\n
\n
\n
\n
\n

value [required]

\n
\n

double

\n

The percentage weight for this variant.

\n
\n \n
\n
\n
\n
\n
\n

variant_id

\n
\n

uuid

\n

The variant ID to assign weight to.

\n
\n \n
\n
\n
\n
\n
\n

variant_key

\n
\n

string

\n

The variant key to assign weight to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type. \nAllowed enum values: allocations

\n
\n \n
\n
\n
\n
" } }, "UpdateAllocationsForFeatureFlagInEnvironment": { @@ -1642,6 +1638,7 @@ "created_at": "2024-01-01T12:00:00Z", "id": "550e8400-e29b-41d4-a716-446655440070", "operator": "ONE_OF", + "saved_filter_id": "550e8400-e29b-41d4-a716-446655440090", "updated_at": "2024-01-01T12:00:00Z", "value": [ "US", @@ -1679,7 +1676,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of targeting rules (allocations).

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule allocation was created.

\n
\n \n
\n
\n
\n
\n
\n

environment_ids [required]

\n
\n

[string]

\n

Environment IDs associated with this targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

experiment_id

\n
\n

string

\n

The experiment ID linked to this targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

exposure_schedule

\n
\n

object

\n

Progressive release details for a targeting rule allocation.

\n
\n
\n
\n
\n
\n

absolute_start_time

\n
\n

date-time

\n

The absolute UTC start time for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

allocation_id [required]

\n
\n

uuid

\n

The targeting rule allocation ID this progressive rollout belongs to.

\n
\n \n
\n
\n
\n
\n
\n

control_variant_id

\n
\n

string

\n

The control variant ID used for experiment comparisons.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the schedule was created.

\n
\n \n
\n
\n
\n
\n
\n

guardrail_triggered_action

\n
\n

string

\n

Last guardrail action triggered for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

guardrail_triggers [required]

\n
\n

[object]

\n

Guardrail trigger records for this schedule.

\n
\n
\n
\n
\n
\n

allocation_exposure_schedule_id [required]

\n
\n

uuid

\n

The progressive rollout ID this trigger belongs to.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when this trigger was created.

\n
\n \n
\n
\n
\n
\n
\n

flagging_variant_id [required]

\n
\n

uuid

\n

The variant ID that triggered this event.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the guardrail trigger.

\n
\n \n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID associated with the trigger.

\n
\n \n
\n
\n
\n
\n
\n

triggered_action [required]

\n
\n

string

\n

The action that was triggered.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when this trigger was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the progressive rollout.

\n
\n \n
\n
\n
\n
\n
\n

rollout_options [required]

\n
\n

object

\n

Applied progression options for a progressive rollout.

\n
\n
\n
\n
\n
\n

autostart [required]

\n
\n

boolean

\n

Whether the schedule starts automatically.

\n
\n \n
\n
\n
\n
\n
\n

selection_interval_ms [required]

\n
\n

int64

\n

Interval in milliseconds for uniform interval strategies.

\n
\n \n
\n
\n
\n
\n
\n

strategy [required]

\n
\n

enum

\n

The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rollout_steps [required]

\n
\n

[object]

\n

Ordered progression steps for exposure.

\n
\n
\n
\n
\n
\n

allocation_exposure_schedule_id [required]

\n
\n

uuid

\n

The progressive rollout ID this step belongs to.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the progression step was created.

\n
\n \n
\n
\n
\n
\n
\n

exposure_ratio [required]

\n
\n

double

\n

The exposure ratio for this step.

\n
\n \n
\n
\n
\n
\n
\n

grouped_step_index [required]

\n
\n

int64

\n

Logical index grouping related steps.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the progression step.

\n
\n \n
\n
\n
\n
\n
\n

interval_ms

\n
\n

int64

\n

Step duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

is_pause_record [required]

\n
\n

boolean

\n

Whether this step represents a pause record.

\n
\n \n
\n
\n
\n
\n
\n

order_position [required]

\n
\n

int64

\n

Sort order for the progression step.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the progression step was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the schedule was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

guardrail_metrics [required]

\n
\n

[object]

\n

Guardrail metrics associated with this targeting rule allocation.

\n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID to monitor.

\n
\n \n
\n
\n
\n
\n
\n

trigger_action [required]

\n
\n

enum

\n

Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT

\n
\n \n
\n
\n
\n
\n
\n

triggered_by

\n
\n

string

\n

The signal or system that triggered the action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

order_position [required]

\n
\n

int64

\n

Sort order position within the environment.

\n
\n \n
\n
\n
\n
\n
\n

targeting_rules [required]

\n
\n

[object]

\n

Conditions associated with this targeting rule allocation.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions evaluated by this targeting rule.

\n
\n
\n
\n
\n
\n

attribute [required]

\n
\n

string

\n

The user or request attribute to evaluate.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the condition was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the condition.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the condition was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

[string]

\n

Values used by the selected operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule allocation was last updated.

\n
\n \n
\n
\n
\n
\n
\n

variant_weights [required]

\n
\n

[object]

\n

Weighted variant assignments for this targeting rule allocation.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The timestamp when the variant weight was created.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Unique identifier of the variant weight assignment.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The timestamp when the variant weight was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

double

\n

The percentage weight for the variant.

\n
\n \n
\n
\n
\n
\n
\n

variant

\n
\n

object

\n

A variant of a feature flag.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The timestamp when the variant was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the variant.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the variant.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the variant.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The timestamp when the variant was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The value of the variant as a string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

variant_id [required]

\n
\n

uuid

\n

The variant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type. \nAllowed enum values: allocations

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of targeting rules (allocations).

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule allocation was created.

\n
\n \n
\n
\n
\n
\n
\n

environment_ids [required]

\n
\n

[string]

\n

Environment IDs associated with this targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

experiment_id

\n
\n

string

\n

The experiment ID linked to this targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

exposure_schedule

\n
\n

object

\n

Progressive release details for a targeting rule allocation.

\n
\n
\n
\n
\n
\n

absolute_start_time

\n
\n

date-time

\n

The absolute UTC start time for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

allocation_id [required]

\n
\n

uuid

\n

The targeting rule allocation ID this progressive rollout belongs to.

\n
\n \n
\n
\n
\n
\n
\n

control_variant_id

\n
\n

string

\n

The control variant ID used for experiment comparisons.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the schedule was created.

\n
\n \n
\n
\n
\n
\n
\n

guardrail_triggered_action

\n
\n

string

\n

Last guardrail action triggered for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

guardrail_triggers [required]

\n
\n

[object]

\n

Guardrail trigger records for this schedule.

\n
\n
\n
\n
\n
\n

allocation_exposure_schedule_id [required]

\n
\n

uuid

\n

The progressive rollout ID this trigger belongs to.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when this trigger was created.

\n
\n \n
\n
\n
\n
\n
\n

flagging_variant_id [required]

\n
\n

uuid

\n

The variant ID that triggered this event.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the guardrail trigger.

\n
\n \n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID associated with the trigger.

\n
\n \n
\n
\n
\n
\n
\n

triggered_action [required]

\n
\n

string

\n

The action that was triggered.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when this trigger was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the progressive rollout.

\n
\n \n
\n
\n
\n
\n
\n

rollout_options [required]

\n
\n

object

\n

Applied progression options for a progressive rollout.

\n
\n
\n
\n
\n
\n

autostart [required]

\n
\n

boolean

\n

Whether the schedule starts automatically.

\n
\n \n
\n
\n
\n
\n
\n

selection_interval_ms [required]

\n
\n

int64

\n

Interval in milliseconds for uniform interval strategies.

\n
\n \n
\n
\n
\n
\n
\n

strategy [required]

\n
\n

enum

\n

The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rollout_steps [required]

\n
\n

[object]

\n

Ordered progression steps for exposure.

\n
\n
\n
\n
\n
\n

allocation_exposure_schedule_id [required]

\n
\n

uuid

\n

The progressive rollout ID this step belongs to.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the progression step was created.

\n
\n \n
\n
\n
\n
\n
\n

exposure_ratio [required]

\n
\n

double

\n

The exposure ratio for this step.

\n
\n \n
\n
\n
\n
\n
\n

grouped_step_index [required]

\n
\n

int64

\n

Logical index grouping related steps.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the progression step.

\n
\n \n
\n
\n
\n
\n
\n

interval_ms

\n
\n

int64

\n

Step duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

is_pause_record [required]

\n
\n

boolean

\n

Whether this step represents a pause record.

\n
\n \n
\n
\n
\n
\n
\n

order_position [required]

\n
\n

int64

\n

Sort order for the progression step.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the progression step was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the schedule was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

guardrail_metrics [required]

\n
\n

[object]

\n

Guardrail metrics associated with this targeting rule allocation.

\n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID to monitor.

\n
\n \n
\n
\n
\n
\n
\n

trigger_action [required]

\n
\n

enum

\n

Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT

\n
\n \n
\n
\n
\n
\n
\n

triggered_by

\n
\n

string

\n

The signal or system that triggered the action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

order_position [required]

\n
\n

int64

\n

Sort order position within the environment.

\n
\n \n
\n
\n
\n
\n
\n

targeting_rules [required]

\n
\n

[object]

\n

Conditions associated with this targeting rule allocation.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions evaluated by this targeting rule.

\n
\n
\n
\n
\n
\n

attribute

\n
\n

string

\n

The user or request attribute to evaluate. Omitted for saved-filter references.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the condition was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the condition.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

enum

\n

The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS

\n
\n \n
\n
\n
\n
\n
\n

saved_filter_id

\n
\n

uuid

\n

The ID of the saved filter referenced by this condition, or null for inline conditions.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the condition was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

Values used by the selected operator. Omitted for saved-filter references.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule allocation was last updated.

\n
\n \n
\n
\n
\n
\n
\n

variant_weights [required]

\n
\n

[object]

\n

Weighted variant assignments for this targeting rule allocation.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The timestamp when the variant weight was created.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Unique identifier of the variant weight assignment.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The timestamp when the variant weight was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

double

\n

The percentage weight for the variant.

\n
\n \n
\n
\n
\n
\n
\n

variant

\n
\n

object

\n

A variant of a feature flag.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The timestamp when the variant was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the variant.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the variant.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the variant.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The timestamp when the variant was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The value of the variant as a string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

variant_id [required]

\n
\n

uuid

\n

The variant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type. \nAllowed enum values: allocations

\n
\n \n
\n
\n
\n
" }, "202": { "json": { @@ -1748,6 +1745,7 @@ "created_at": "2024-01-01T12:00:00Z", "id": "550e8400-e29b-41d4-a716-446655440070", "operator": "ONE_OF", + "saved_filter_id": "550e8400-e29b-41d4-a716-446655440090", "updated_at": "2024-01-01T12:00:00Z", "value": [ "US", @@ -1785,7 +1783,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of targeting rules (allocations).

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule allocation was created.

\n
\n \n
\n
\n
\n
\n
\n

environment_ids [required]

\n
\n

[string]

\n

Environment IDs associated with this targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

experiment_id

\n
\n

string

\n

The experiment ID linked to this targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

exposure_schedule

\n
\n

object

\n

Progressive release details for a targeting rule allocation.

\n
\n
\n
\n
\n
\n

absolute_start_time

\n
\n

date-time

\n

The absolute UTC start time for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

allocation_id [required]

\n
\n

uuid

\n

The targeting rule allocation ID this progressive rollout belongs to.

\n
\n \n
\n
\n
\n
\n
\n

control_variant_id

\n
\n

string

\n

The control variant ID used for experiment comparisons.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the schedule was created.

\n
\n \n
\n
\n
\n
\n
\n

guardrail_triggered_action

\n
\n

string

\n

Last guardrail action triggered for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

guardrail_triggers [required]

\n
\n

[object]

\n

Guardrail trigger records for this schedule.

\n
\n
\n
\n
\n
\n

allocation_exposure_schedule_id [required]

\n
\n

uuid

\n

The progressive rollout ID this trigger belongs to.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when this trigger was created.

\n
\n \n
\n
\n
\n
\n
\n

flagging_variant_id [required]

\n
\n

uuid

\n

The variant ID that triggered this event.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the guardrail trigger.

\n
\n \n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID associated with the trigger.

\n
\n \n
\n
\n
\n
\n
\n

triggered_action [required]

\n
\n

string

\n

The action that was triggered.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when this trigger was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the progressive rollout.

\n
\n \n
\n
\n
\n
\n
\n

rollout_options [required]

\n
\n

object

\n

Applied progression options for a progressive rollout.

\n
\n
\n
\n
\n
\n

autostart [required]

\n
\n

boolean

\n

Whether the schedule starts automatically.

\n
\n \n
\n
\n
\n
\n
\n

selection_interval_ms [required]

\n
\n

int64

\n

Interval in milliseconds for uniform interval strategies.

\n
\n \n
\n
\n
\n
\n
\n

strategy [required]

\n
\n

enum

\n

The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rollout_steps [required]

\n
\n

[object]

\n

Ordered progression steps for exposure.

\n
\n
\n
\n
\n
\n

allocation_exposure_schedule_id [required]

\n
\n

uuid

\n

The progressive rollout ID this step belongs to.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the progression step was created.

\n
\n \n
\n
\n
\n
\n
\n

exposure_ratio [required]

\n
\n

double

\n

The exposure ratio for this step.

\n
\n \n
\n
\n
\n
\n
\n

grouped_step_index [required]

\n
\n

int64

\n

Logical index grouping related steps.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the progression step.

\n
\n \n
\n
\n
\n
\n
\n

interval_ms

\n
\n

int64

\n

Step duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

is_pause_record [required]

\n
\n

boolean

\n

Whether this step represents a pause record.

\n
\n \n
\n
\n
\n
\n
\n

order_position [required]

\n
\n

int64

\n

Sort order for the progression step.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the progression step was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the schedule was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

guardrail_metrics [required]

\n
\n

[object]

\n

Guardrail metrics associated with this targeting rule allocation.

\n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID to monitor.

\n
\n \n
\n
\n
\n
\n
\n

trigger_action [required]

\n
\n

enum

\n

Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT

\n
\n \n
\n
\n
\n
\n
\n

triggered_by

\n
\n

string

\n

The signal or system that triggered the action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

order_position [required]

\n
\n

int64

\n

Sort order position within the environment.

\n
\n \n
\n
\n
\n
\n
\n

targeting_rules [required]

\n
\n

[object]

\n

Conditions associated with this targeting rule allocation.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions evaluated by this targeting rule.

\n
\n
\n
\n
\n
\n

attribute [required]

\n
\n

string

\n

The user or request attribute to evaluate.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the condition was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the condition.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the condition was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

[string]

\n

Values used by the selected operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule allocation was last updated.

\n
\n \n
\n
\n
\n
\n
\n

variant_weights [required]

\n
\n

[object]

\n

Weighted variant assignments for this targeting rule allocation.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The timestamp when the variant weight was created.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Unique identifier of the variant weight assignment.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The timestamp when the variant weight was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

double

\n

The percentage weight for the variant.

\n
\n \n
\n
\n
\n
\n
\n

variant

\n
\n

object

\n

A variant of a feature flag.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The timestamp when the variant was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the variant.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the variant.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the variant.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The timestamp when the variant was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The value of the variant as a string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

variant_id [required]

\n
\n

uuid

\n

The variant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type. \nAllowed enum values: allocations

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of targeting rules (allocations).

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule allocation was created.

\n
\n \n
\n
\n
\n
\n
\n

environment_ids [required]

\n
\n

[string]

\n

Environment IDs associated with this targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

experiment_id

\n
\n

string

\n

The experiment ID linked to this targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

exposure_schedule

\n
\n

object

\n

Progressive release details for a targeting rule allocation.

\n
\n
\n
\n
\n
\n

absolute_start_time

\n
\n

date-time

\n

The absolute UTC start time for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

allocation_id [required]

\n
\n

uuid

\n

The targeting rule allocation ID this progressive rollout belongs to.

\n
\n \n
\n
\n
\n
\n
\n

control_variant_id

\n
\n

string

\n

The control variant ID used for experiment comparisons.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the schedule was created.

\n
\n \n
\n
\n
\n
\n
\n

guardrail_triggered_action

\n
\n

string

\n

Last guardrail action triggered for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

guardrail_triggers [required]

\n
\n

[object]

\n

Guardrail trigger records for this schedule.

\n
\n
\n
\n
\n
\n

allocation_exposure_schedule_id [required]

\n
\n

uuid

\n

The progressive rollout ID this trigger belongs to.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when this trigger was created.

\n
\n \n
\n
\n
\n
\n
\n

flagging_variant_id [required]

\n
\n

uuid

\n

The variant ID that triggered this event.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the guardrail trigger.

\n
\n \n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID associated with the trigger.

\n
\n \n
\n
\n
\n
\n
\n

triggered_action [required]

\n
\n

string

\n

The action that was triggered.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when this trigger was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the progressive rollout.

\n
\n \n
\n
\n
\n
\n
\n

rollout_options [required]

\n
\n

object

\n

Applied progression options for a progressive rollout.

\n
\n
\n
\n
\n
\n

autostart [required]

\n
\n

boolean

\n

Whether the schedule starts automatically.

\n
\n \n
\n
\n
\n
\n
\n

selection_interval_ms [required]

\n
\n

int64

\n

Interval in milliseconds for uniform interval strategies.

\n
\n \n
\n
\n
\n
\n
\n

strategy [required]

\n
\n

enum

\n

The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rollout_steps [required]

\n
\n

[object]

\n

Ordered progression steps for exposure.

\n
\n
\n
\n
\n
\n

allocation_exposure_schedule_id [required]

\n
\n

uuid

\n

The progressive rollout ID this step belongs to.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the progression step was created.

\n
\n \n
\n
\n
\n
\n
\n

exposure_ratio [required]

\n
\n

double

\n

The exposure ratio for this step.

\n
\n \n
\n
\n
\n
\n
\n

grouped_step_index [required]

\n
\n

int64

\n

Logical index grouping related steps.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the progression step.

\n
\n \n
\n
\n
\n
\n
\n

interval_ms

\n
\n

int64

\n

Step duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

is_pause_record [required]

\n
\n

boolean

\n

Whether this step represents a pause record.

\n
\n \n
\n
\n
\n
\n
\n

order_position [required]

\n
\n

int64

\n

Sort order for the progression step.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the progression step was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the schedule was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

guardrail_metrics [required]

\n
\n

[object]

\n

Guardrail metrics associated with this targeting rule allocation.

\n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID to monitor.

\n
\n \n
\n
\n
\n
\n
\n

trigger_action [required]

\n
\n

enum

\n

Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT

\n
\n \n
\n
\n
\n
\n
\n

triggered_by

\n
\n

string

\n

The signal or system that triggered the action.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

order_position [required]

\n
\n

int64

\n

Sort order position within the environment.

\n
\n \n
\n
\n
\n
\n
\n

targeting_rules [required]

\n
\n

[object]

\n

Conditions associated with this targeting rule allocation.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions evaluated by this targeting rule.

\n
\n
\n
\n
\n
\n

attribute

\n
\n

string

\n

The user or request attribute to evaluate. Omitted for saved-filter references.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the condition was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the condition.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

enum

\n

The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS

\n
\n \n
\n
\n
\n
\n
\n

saved_filter_id

\n
\n

uuid

\n

The ID of the saved filter referenced by this condition, or null for inline conditions.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the condition was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

Values used by the selected operator. Omitted for saved-filter references.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The timestamp when the targeting rule allocation was last updated.

\n
\n \n
\n
\n
\n
\n
\n

variant_weights [required]

\n
\n

[object]

\n

Weighted variant assignments for this targeting rule allocation.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The timestamp when the variant weight was created.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Unique identifier of the variant weight assignment.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The timestamp when the variant weight was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

double

\n

The percentage weight for the variant.

\n
\n \n
\n
\n
\n
\n
\n

variant

\n
\n

object

\n

A variant of a feature flag.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The timestamp when the variant was created.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the variant.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the variant.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the variant.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The timestamp when the variant was last updated.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The value of the variant as a string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

variant_id [required]

\n
\n

uuid

\n

The variant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type. \nAllowed enum values: allocations

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1856,14 +1854,7 @@ "targeting_rules": [ { "conditions": [ - { - "attribute": "user_tier", - "operator": "ONE_OF", - "value": [ - "premium", - "enterprise" - ] - } + {} ] } ], @@ -1918,6 +1909,7 @@ { "attribute": "user_tier", "operator": "ONE_OF", + "saved_filter_id": "550e8400-e29b-41d4-a716-446655440090", "value": [ "premium", "enterprise" @@ -1939,7 +1931,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Targeting rules (allocations) to replace existing ones with.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

experiment_id

\n
\n

string

\n

The experiment ID for experiment-linked allocations.

\n
\n \n
\n
\n
\n
\n
\n

exposure_schedule

\n
\n

object

\n

Progressive release request payload.

\n
\n
\n
\n
\n
\n

absolute_start_time

\n
\n

date-time

\n

The absolute UTC start time for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

control_variant_id

\n
\n

string

\n

The control variant ID used for experiment comparisons.

\n
\n \n
\n
\n
\n
\n
\n

control_variant_key

\n
\n

string

\n

The control variant key used during creation workflows.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the progressive rollout.

\n
\n \n
\n
\n
\n
\n
\n

rollout_options [required]

\n
\n

object

\n

Rollout options request payload.

\n
\n
\n
\n
\n
\n

autostart

\n
\n

boolean

\n

Whether the schedule should begin automatically.

\n
\n \n
\n
\n
\n
\n
\n

selection_interval_ms

\n
\n

int64

\n

Interval in milliseconds for uniform interval strategies.

\n
\n \n
\n
\n
\n
\n
\n

strategy [required]

\n
\n

enum

\n

The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rollout_steps [required]

\n
\n

[object]

\n

Ordered progression steps for exposure.

\n
\n
\n
\n
\n
\n

exposure_ratio [required]

\n
\n

double

\n

The exposure ratio for this step.

\n
\n \n
\n
\n
\n
\n
\n

grouped_step_index [required]

\n
\n

int64

\n

Logical index grouping related steps.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the progression step.

\n
\n \n
\n
\n
\n
\n
\n

interval_ms

\n
\n

int64

\n

Step duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

is_pause_record [required]

\n
\n

boolean

\n

Whether this step represents a pause record.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

guardrail_metrics

\n
\n

[object]

\n

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

\n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID to monitor.

\n
\n \n
\n
\n
\n
\n
\n

trigger_action [required]

\n
\n

enum

\n

Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

targeting_rules

\n
\n

[object]

\n

Targeting rules that determine audience eligibility.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions that must match for this rule.

\n
\n
\n
\n
\n
\n

attribute [required]

\n
\n

string

\n

The user or request attribute to evaluate.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

[string]

\n

Values used by the selected operator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY

\n
\n \n
\n
\n
\n
\n
\n

variant_weights

\n
\n

[object]

\n

Variant distribution weights.

\n
\n
\n
\n
\n
\n

value [required]

\n
\n

double

\n

The percentage weight for this variant.

\n
\n \n
\n
\n
\n
\n
\n

variant_id

\n
\n

uuid

\n

The variant ID to assign weight to.

\n
\n \n
\n
\n
\n
\n
\n

variant_key

\n
\n

string

\n

The variant key to assign weight to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type. \nAllowed enum values: allocations

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Targeting rules (allocations) to replace existing ones with.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

experiment_id

\n
\n

string

\n

The experiment ID for experiment-linked allocations.

\n
\n \n
\n
\n
\n
\n
\n

exposure_schedule

\n
\n

object

\n

Progressive release request payload.

\n
\n
\n
\n
\n
\n

absolute_start_time

\n
\n

date-time

\n

The absolute UTC start time for this schedule.

\n
\n \n
\n
\n
\n
\n
\n

control_variant_id

\n
\n

string

\n

The control variant ID used for experiment comparisons.

\n
\n \n
\n
\n
\n
\n
\n

control_variant_key

\n
\n

string

\n

The control variant key used during creation workflows.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the progressive rollout.

\n
\n \n
\n
\n
\n
\n
\n

rollout_options [required]

\n
\n

object

\n

Rollout options request payload.

\n
\n
\n
\n
\n
\n

autostart

\n
\n

boolean

\n

Whether the schedule should begin automatically.

\n
\n \n
\n
\n
\n
\n
\n

selection_interval_ms

\n
\n

int64

\n

Interval in milliseconds for uniform interval strategies.

\n
\n \n
\n
\n
\n
\n
\n

strategy [required]

\n
\n

enum

\n

The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rollout_steps [required]

\n
\n

[object]

\n

Ordered progression steps for exposure.

\n
\n
\n
\n
\n
\n

exposure_ratio [required]

\n
\n

double

\n

The exposure ratio for this step.

\n
\n \n
\n
\n
\n
\n
\n

grouped_step_index [required]

\n
\n

int64

\n

Logical index grouping related steps.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the progression step.

\n
\n \n
\n
\n
\n
\n
\n

interval_ms

\n
\n

int64

\n

Step duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

is_pause_record [required]

\n
\n

boolean

\n

Whether this step represents a pause record.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

guardrail_metrics

\n
\n

[object]

\n

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

\n
\n
\n
\n
\n
\n

metric_id [required]

\n
\n

string

\n

The metric ID to monitor.

\n
\n \n
\n
\n
\n
\n
\n

trigger_action [required]

\n
\n

enum

\n

Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The unique identifier of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

The unique key of the targeting rule allocation.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the targeting rule.

\n
\n \n
\n
\n
\n
\n
\n

targeting_rules

\n
\n

[object]

\n

Targeting rules that determine audience eligibility.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions that must match for this rule.

\n
\n
\n
\n
\n
\n

attribute

\n
\n

string

\n

The user or request attribute to evaluate. Required for inline conditions; omit when saved_filter_id is set.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

enum

\n

The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS

\n
\n \n
\n
\n
\n
\n
\n

saved_filter_id

\n
\n

uuid

\n

The ID of a saved filter to reference as this condition. Mutually exclusive\nwith operator, attribute, and value. When set, the saved filter's\ntargeting rules are evaluated in place of an inline predicate.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

Values used by the selected operator. Required for inline conditions; omit when saved_filter_id is set.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY

\n
\n \n
\n
\n
\n
\n
\n

variant_weights

\n
\n

[object]

\n

Variant distribution weights.

\n
\n
\n
\n
\n
\n

value [required]

\n
\n

double

\n

The percentage weight for this variant.

\n
\n \n
\n
\n
\n
\n
\n

variant_id

\n
\n

uuid

\n

The variant ID to assign weight to.

\n
\n \n
\n
\n
\n
\n
\n

variant_key

\n
\n

string

\n

The variant key to assign weight to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type. \nAllowed enum values: allocations

\n
\n \n
\n
\n
\n
" } }, "DisableFeatureFlagEnvironment": { diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 9972a379429..df56875c110 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -19546,10 +19546,14 @@ components: - CONTAINER - CALLOUTVALUE Condition: - description: Targeting condition details. + description: |- + Targeting condition details. A condition is either an inline + predicate with `operator`, `attribute`, and `value`, or a reference to a + saved filter with `saved_filter_id`. The inline fields are omitted for saved-filter + references. properties: attribute: - description: The user or request attribute to evaluate. + description: The user or request attribute to evaluate. Omitted for saved-filter references. example: "country" type: string created_at: @@ -19564,13 +19568,19 @@ components: type: string operator: $ref: "#/components/schemas/ConditionOperator" + saved_filter_id: + description: The ID of the saved filter referenced by this condition, or null for inline conditions. + example: "550e8400-e29b-41d4-a716-446655440090" + format: uuid + nullable: true + type: string updated_at: description: The timestamp when the condition was last updated. example: "2024-01-01T12:00:00Z" format: date-time type: string value: - description: Values used by the selected operator. + description: Values used by the selected operator. Omitted for saved-filter references. example: ["US", "CA"] items: description: Target value for the selected operator. @@ -19578,9 +19588,6 @@ components: type: array required: - id - - operator - - attribute - - value - created_at - updated_at type: object @@ -19611,25 +19618,32 @@ components: - IS_NULL - EQUALS ConditionRequest: - description: Condition request payload for targeting rules. + description: |- + Condition request payload for targeting rules. A condition is either an inline + predicate with `operator`, `attribute`, and `value`, or a reference to a + saved filter with `saved_filter_id`. The two shapes are mutually exclusive. properties: attribute: - description: The user or request attribute to evaluate. + description: The user or request attribute to evaluate. Required for inline conditions; omit when `saved_filter_id` is set. example: "user_tier" type: string operator: $ref: "#/components/schemas/ConditionOperator" + saved_filter_id: + description: |- + The ID of a saved filter to reference as this condition. Mutually exclusive + with `operator`, `attribute`, and `value`. When set, the saved filter's + targeting rules are evaluated in place of an inline predicate. + example: "550e8400-e29b-41d4-a716-446655440090" + format: uuid + type: string value: - description: Values used by the selected operator. + description: Values used by the selected operator. Required for inline conditions; omit when `saved_filter_id` is set. example: ["premium", "enterprise"] items: description: Target value for the selected operator. type: string type: array - required: - - operator - - attribute - - value type: object ConfigCatCredentials: description: The definition of the `ConfigCatCredentials` object.