Evaluate flags for context instance | LaunchDarkly

curl -X POST https://app.launchdarkly.com/api/v2/projects/projectKey/environments/environmentKey/flags/evaluate \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "key": "user-key-123abc",
  "kind": "user",
  "otherAttribute": "other attribute value"
}'

{
  "items": [
    {
      "name": "SortOrder",
      "key": "sort.order",
      "_value": null,
      "_links": {
        "self": {
          "href": "/api/v2/projects/{projectKey}/environments/{environmentKey}/flags/evaluate",
          "type": "application/json"
        },
        "site": {
          "href": "/my-project/my-environment/features/sort.order/targeting",
          "type": "text/html"
        }
      },
      "reason": {
        "kind": "FALLTHROUGH"
      }
    },
    {
      "name": "AlternatePage",
      "key": "alternate.page",
      "_value": null,
      "_links": {
        "self": {
          "href": "/api/v2/projects/{projectKey}/environments/{environmentKey}/flags/evaluate",
          "type": "application/json"
        },
        "site": {
          "href": "/my-project/my-environment/features/alternate.page/targeting",
          "type": "text/html"
        }
      },
      "reason": {
        "kind": "RULE_MATCH",
        "ruleIndex": 1,
        "ruleID": "b2530cdf-14c6-4e16-b660-00239e08f19b"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "/api/v2/projects/{projectKey}/environments/{environmentKey}/flags/evaluate",
      "type": "application/json"
    }
  },
  "totalCount": 2
}

Evaluate flags for a context instance, for example, to determine the expected flag variation. Do not use this API instead of an SDK. The LaunchDarkly SDKs are specialized for the tasks of evaluating feature flags in your application at scale and generating analytics events based on those evaluations. This API is not designed for that use case. Any evaluations you perform with this API will not be reflected in features such as flag statuses and flag insights. Context instances evaluated by this API will not appear in the Contexts list. To learn more, read Comparing LaunchDarkly’s SDKs and REST API.

Filtering

LaunchDarkly supports the filter query param for filtering, with the following fields:

query filters for a string that matches against the flags’ keys and names. It is not case sensitive. For example: filter=query equals dark-mode.
tags filters the list to flags that have all of the tags in the list. For example: filter=tags contains ["beta","q1"].

You can also apply multiple filters at once. For example, setting filter=query equals dark-mode, tags contains ["beta","q1"] matches flags which match the key or name dark-mode and are tagged beta and q1.

Evaluate flags for a context instance, for example, to determine the expected flag variation. **Do not use this API instead of an SDK.** The LaunchDarkly SDKs are specialized for the tasks of evaluating feature flags in your application at scale and generating analytics events based on those evaluations. This API is not designed for that use case. Any evaluations you perform with this API will not be reflected in features such as flag statuses and flag insights. Context instances evaluated by this API will not appear in the Contexts list. To learn more, read [Comparing LaunchDarkly's SDKs and REST API](https://launchdarkly.com/docs/guides/api/comparing-sdk-rest-api). ### Filtering LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `query` filters for a string that matches against the flags' keys and names. It is not case sensitive. For example: `filter=query equals dark-mode`. - `tags` filters the list to flags that have all of the tags in the list. For example: `filter=tags contains ["beta","q1"]`. You can also apply multiple filters at once. For example, setting `filter=query equals dark-mode, tags contains ["beta","q1"]` matches flags which match the key or name `dark-mode` and are tagged `beta` and `q1`.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

environmentKeystringRequiredformat: "string"

The environment key

Query parameters

limitlongOptional

The number of feature flags to return. Defaults to -1, which returns all flags

offsetlongOptional

Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

sortstringOptionalformat: "string"

A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order

filterstringOptionalformat: "string"

A comma-separated list of filters. Each filter is of the form field operator value. Supported fields are explained above.

Request

This endpoint expects a map from strings to any.

Response

Flag evaluation collection response

itemslist of objects

Details on the flag evaluations for this context instance

_linksmap from strings to objects

The location and content type of related resources

totalCountinteger

The number of flags

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

Filtering

LaunchDarkly supports the filter query param for filtering, with the following fields:

query filters for a string that matches against the flags’ keys and names. It is not case sensitive. For example: filter=query equals dark-mode.
tags filters the list to flags that have all of the tags in the list. For example: filter=tags contains ["beta","q1"].