Evaluate an Unleash context against a change request preview.

import requests
url = "https://app.unleash-instance.example.com/api/admin/playground/change-request/id"
payload = { "context": { "appName": "My cool application." } }
headers = {
    "Authorization": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "input": {
    "environments": [
      "development",
      "production"
    ],
    "context": {
      "appName": "My cool application.",
      "currentTime": "2022-07-05T12:56:41+02:00",
      "properties": {
        "customContextField": "this is one!",
        "otherCustomField": "3"
      },
      "remoteAddress": "192.168.1.1",
      "sessionId": "b65e7b23-fec0-4814-a129-0e9861ef18fc",
      "userId": "username@provider.com",
      "environment": "string"
    },
    "projects": [
      "my-project"
    ]
  },
  "features": [
    {
      "name": "my-feature",
      "projectId": "my-project",
      "environments": {}
    }
  ],
  "warnings": {
    "invalidContextProperties": [
      "string"
    ]
  }
}

Enterprise feature

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.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Path parameters

idstringRequired

Request

changeRequestPlaygroundRequestSchema

contextobjectRequired

The Unleash context as modeled in client SDKs

Response

advancedPlaygroundResponseSchema

inputobject

The given input used to evaluate the features.

featureslist of objects

The list of features that have been evaluated.

warningsobject or null

Warnings that occurred during evaluation.

Authentication

Path parameters

Request

Response

Errors