Skip to main content

Evaluate an Unleash context against a change request preview.

POST /api/admin/playground/change-request/:id

Use the provided context to evaluate toggles on this Unleash instance with a change request applied in preview mode. You can use comma-separated values to provide multiple values to each context field. Returns a combinatorial list of all toggles that match the parameters and what they evaluate to.

Request

Path Parameters

  • id string required

Body

required

changeRequestPlaygroundRequestSchema

  • context objectrequired

    The Unleash context as modeled in client SDKs

  • appName string required

    Possible values: non-empty

    The name of the application.

  • currentTime date-time

    A DateTime (or similar) data class instance or a string in an RFC3339-compatible format. Defaults to the current time if not set by the user.

  • environment string deprecated

    The environment the app is running in.

  • properties object

    Additional Unleash context properties

  • property name* string
  • remoteAddress string

    The app's IP address

  • sessionId string

    An identifier for the current session

  • userId string

    An identifier for the current user

  • property name* any

    The Unleash context as modeled in client SDKs

Responses

advancedPlaygroundResponseSchema

Schema
  • input objectrequired

    The given input used to evaluate the features.

  • environments string[] required

    Possible values: >= 1

    The environments to evaluate toggles in.

  • projects object

    A list of projects to check for toggles in.

    oneOf
  • Array [
  • string
  • ]
  • context objectrequired

    The Unleash context as modeled in client SDKs

  • appName string required

    Possible values: non-empty

    The name of the application.

  • currentTime date-time

    A DateTime (or similar) data class instance or a string in an RFC3339-compatible format. Defaults to the current time if not set by the user.

  • environment string deprecated

    The environment the app is running in.

  • properties object

    Additional Unleash context properties

  • property name* string
  • remoteAddress string

    The app's IP address

  • sessionId string

    An identifier for the current session

  • userId string

    An identifier for the current user

  • property name* any

    The Unleash context as modeled in client SDKs

  • features object[]required

    The list of features that have been evaluated.

  • Array [
  • name string required

    The feature's name.

  • projectId string required

    The ID of the project that contains this feature.

  • environments objectrequired

    The lists of features that have been evaluated grouped by environment.

  • property name* object[]
  • Array [
  • name string required

    The feature's name.

  • environment string required

    The feature's environment.

  • context objectrequired

    The context to use when evaluating flags

  • appName string required

    Possible values: non-empty

    The name of the application.

  • currentTime date-time

    A DateTime (or similar) data class instance or a string in an RFC3339-compatible format. Defaults to the current time if not set by the user.

  • environment string deprecated

    The environment the app is running in.

  • remoteAddress string

    The app's IP address

  • sessionId string

    An identifier for the current session

  • userId string

    An identifier for the current user

  • property name* any

    The context to use when evaluating flags

  • projectId string required

    The ID of the project that contains this feature.

  • strategies objectrequired

    Feature's applicable strategies and cumulative results of the strategies

  • result objectrequired

    The cumulative results of all the feature's strategies. Can be true, false, or unknown. This property will only be unknown if one or more of the strategies can't be fully evaluated and the rest of the strategies all resolve to false.

    anyOf
  • boolean
  • data object[]required

    The strategies that apply to this feature.

  • Array [
  • name string required

    The strategy's name.

  • title string

    Description of the feature's purpose.

  • id string required

    The strategy's id.

  • result objectrequired

    The strategy's evaluation result. If the strategy is a custom strategy that Unleash can't evaluate, evaluationStatus will be unknown. Otherwise, it will be true or false

    anyOf
  • evaluationStatus string required

    Possible values: [incomplete, unevaluated]

    Signals that this strategy could not be evaluated. This is most likely because you're using a custom strategy that Unleash doesn't know about. The unevaluated result is also returned if the strategy is disabled.

  • enabled objectrequired

    Whether this strategy resolves to false or if it might resolve to true. Because Unleash can't evaluate the strategy, it can't say for certain whether it will be true, but if you have failing constraints or segments, it can determine that your strategy would be false.

    anyOf
  • boolean

    Possible values: [false]

  • disabled boolean nullable required

    The strategy's status. Disabled strategies are not evaluated

  • segments object[]required

    The strategy's segments and their evaluation results.

  • Array [
  • id integer required

    The segment's id.

  • name string required

    The name of the segment.

  • result boolean required

    Whether this was evaluated as true or false.

  • constraints object[]required

    The list of constraints in this segment.

  • Array [
  • contextName string required

    The name of the context field that this constraint should apply to.

  • operator string required

    Possible values: [NOT_IN, IN, STR_ENDS_WITH, STR_STARTS_WITH, STR_CONTAINS, NUM_EQ, NUM_GT, NUM_GTE, NUM_LT, NUM_LTE, DATE_AFTER, DATE_BEFORE, SEMVER_EQ, SEMVER_GT, SEMVER_LT]

    The operator to use when evaluating this constraint. For more information about the various operators, refer to the strategy constraint operator documentation.

  • caseInsensitive boolean

    Default value: false

    Whether the operator should be case sensitive or not. Defaults to false (being case sensitive).

  • inverted boolean

    Default value: false

    Whether the result should be negated or not. If true, will turn a true result into a false result and vice versa.

  • values string[]

    The context values that should be used for constraint evaluation. Use this property instead of value for properties that accept multiple values.

  • value string

    The context value that should be used for constraint evaluation. Use this property instead of values for properties that only accept single values.

  • result boolean required

    Whether this was evaluated as true or false.

  • ]
  • ]
  • constraints object[]required

    The strategy's constraints and their evaluation results.

  • Array [
  • contextName string required

    The name of the context field that this constraint should apply to.

  • operator string required

    Possible values: [NOT_IN, IN, STR_ENDS_WITH, STR_STARTS_WITH, STR_CONTAINS, NUM_EQ, NUM_GT, NUM_GTE, NUM_LT, NUM_LTE, DATE_AFTER, DATE_BEFORE, SEMVER_EQ, SEMVER_GT, SEMVER_LT]

    The operator to use when evaluating this constraint. For more information about the various operators, refer to the strategy constraint operator documentation.

  • caseInsensitive boolean

    Default value: false

    Whether the operator should be case sensitive or not. Defaults to false (being case sensitive).

  • inverted boolean

    Default value: false

    Whether the result should be negated or not. If true, will turn a true result into a false result and vice versa.

  • values string[]

    The context values that should be used for constraint evaluation. Use this property instead of value for properties that accept multiple values.

  • value string

    The context value that should be used for constraint evaluation. Use this property instead of values for properties that only accept single values.

  • result boolean required

    Whether this was evaluated as true or false.

  • ]
  • parameters objectrequired

    The strategy's constraints and their evaluation results.

  • property name* string
  • links objectrequired

    A set of links to actions you can perform on this strategy

  • edit string required
  • ]
  • isEnabledInCurrentEnvironment boolean required

    Whether the feature is active and would be evaluated in the provided environment in a normal SDK context.

  • isEnabled boolean required

    Whether this feature is enabled or not in the current environment. If a feature can't be fully evaluated (that is, strategies.result is unknown), this will be false to align with how client SDKs treat unresolved feature states.

  • variant objectnullablerequired

    The feature variant you receive based on the provided context or the disabled variant. If a feature is disabled or doesn't have any variants, you would get the disabled variant. Otherwise, you'll get one of the feature's defined variants.

  • name string required

    The variant's name. If there is no variant or if the flag is disabled, this will be disabled

  • enabled boolean required

    Whether the variant is enabled or not. If the feature is disabled or if it doesn't have variants, this property will be false

  • payload object

    An optional payload attached to the variant.

  • type string required

    The format of the payload.

  • value string required

    The payload value stringified.

  • feature_enabled boolean

    Whether the feature is enabled or not. If the feature is disabled, this property will be false

  • variants object[]required

    The feature variants.

  • Array [
  • name string required

    The variants name. Is unique for this feature flag

  • weight number required

    Possible values: <= 1000

    The weight is the likelihood of any one user getting this variant. It is a number between 0 and 1000. See the section on variant weights for more information

  • weightType string

    Possible values: [variable, fix]

    Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000

  • stickiness string

    Stickiness is how Unleash guarantees that the same user gets the same variant every time

  • payload object

    Extra data configured for this variant

  • type string required

    Possible values: [json, csv, string, number]

    The type of the value. Commonly used types are string, number, json and csv.

  • value string required

    The actual value of payload

  • overrides object[]

    Overrides assigning specific variants to specific users. The weighting system automatically assigns users to specific groups for you, but any overrides in this list will take precedence.

  • Array [
  • contextName string required

    The name of the context field used to determine overrides

  • values string[] required

    Which values that should be overriden

  • ]
  • ]
  • ]
  • ]
  • warnings object

    Warnings that occurred during evaluation.

  • invalidContextProperties string[]

    A list of top-level context properties that were provided as input that are not valid due to being the wrong type.

Loading...