このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

Get a single feature flag by key.

Inputs

フィールド

種類

説明

projectKey [required]

string

The project key.

featureFlagKey [required]

string

The feature flag key.

env

string

Filter configurations by environment. When specified, environments that do not match are omitted from the configuration of the feature flag.

Outputs

Expand All

フィールド

種類

説明

name [required]

string

A human-friendly name for the feature flag

kind [required]

enum

Kind of feature flag Allowed enum values: boolean,multivariate

description

string

Description of the feature flag

key [required]

string

A unique key used to reference the flag in your code

_version [required]

number

Version of the feature flag

creationDate [required]

number

includeInSnippet

boolean

DEPRECATED: Deprecated, use clientSideAvailability. Whether this flag should be made available to the client-side JavaScript SDK

clientSideAvailability

object

usingMobileKey

boolean

usingEnvironmentId

boolean

variations [required]

[object]

An array of possible variations for the flag

_id

string

The ID of the variation. Leave empty when you are creating a flag.

value [required]

The value of the variation. For boolean flags, this must be true or false. For multivariate flags, this may be a string, number, or JSON object.

description

string

Description of the variation. Defaults to an empty string, but is omitted from the response if not set.

name

string

A human-friendly name for the variation. Defaults to an empty string, but is omitted from the response if not set.

temporary [required]

boolean

Whether the flag is a temporary flag

tags [required]

[string]

Tags for the feature flag

_links [required]

object

The location and content type of related resources

maintainerId

string

Associated maintainerId for the feature flag

_maintainer

object

_links [required]

object

The location and content type of related resources

_id [required]

string

The member's ID

firstName

string

The member's first name

lastName

string

The member's last name

role [required]

string

The member's built-in role. If the member has no custom roles, this role will be in effect.

email [required]

string

The member's email address

maintainerTeamKey

string

The key of the associated team that maintains this feature flag

_maintainerTeam

object

key

string

The key of the maintainer team

name

string

A human-friendly name for the maintainer team

_links

object

The location and content type of related resources

goalIds

[string]

DEPRECATED: Deprecated, use experiments instead

experiments [required]

object

baselineIdx [required]

number

items [required]

[object]

metricKey

string

_metric

object

experimentCount

number

The number of experiments using this metric

_id [required]

string

The ID of this metric

key [required]

string

A unique key to reference the metric

name [required]

string

A human-friendly name for the metric

kind [required]

enum

The kind of event the metric tracks Allowed enum values: pageview,click,custom

_attachedFlagCount

number

The number of feature flags currently attached to this metric

_links [required]

object

The location and content type of related resources

_site

object

href

string

type

string

_access

object

denied [required]

[object]

action [required]

string

reason [required]

object

resources

[string]

Resource specifier strings

notResources

[string]

Targeted resources are the resources NOT in this list. The resources and notActions fields must be empty to use this field.

actions

[string]

Actions to perform on a resource

notActions

[string]

Targeted actions are the actions NOT in this list. The actions and notResources fields must be empty to use this field.

effect [required]

string

role_name

string

allowed [required]

[object]

action [required]

string

reason [required]

object

resources

[string]

Resource specifier strings

notResources

[string]

Targeted resources are the resources NOT in this list. The resources and notActions fields must be empty to use this field.

actions

[string]

Actions to perform on a resource

notActions

[string]

Targeted actions are the actions NOT in this list. The actions and notResources fields must be empty to use this field.

effect [required]

string

role_name

string

tags [required]

[string]

Tags for the metric

_creationDate [required]

number

lastModified

object

date

string

maintainerId

string

The ID of the member who maintains this metric

_maintainer

object

_links [required]

object

The location and content type of related resources

_id [required]

string

The member's ID

firstName

string

The member's first name

lastName

string

The member's last name

role [required]

string

The member's built-in role. If the member has no custom roles, this role will be in effect.

email [required]

string

The member's email address

description

string

Description of the metric

isNumeric

boolean

For custom metrics, whether to track numeric changes in value against a baseline (true) or to track a conversion when an end user takes an action (false).

successCriteria

enum

For custom metrics, the success criteria Allowed enum values: HigherThanBaseline,LowerThanBaseline

unit

string

For numeric custom metrics, the unit of measure

eventKey

string

For custom metrics, the event name to use in your code

randomizationUnits

[string]

An array of randomization units allowed for this metric

environments

[string]

_environmentSettings

object

customProperties [required]

object

archived [required]

boolean

Boolean indicating if the feature flag is archived

archivedDate

number

defaults

object

onVariation [required]

number

The index, from the array of variations for this flag, of the variation to serve by default when targeting is on.

offVariation [required]

number

The index, from the array of variations for this flag, of the variation to serve by default when targeting is off.

environments [required]

object

Details on the environments for this flag