LaunchDarkly REST API
LaunchDarkly DocsSign in
HomeAPI ReferenceSDKsContext Plugin
Insights flag events (beta)

List flag events

GET
/api/v2/engineering-insights/flag-events

Get a list of flag events

Expanding the flag event collection response

LaunchDarkly supports expanding the flag event collection response to include additional fields.

To expand the response, append the expand query parameter and include the following:

  • experiments includes details on all of the experiments run on each flag

For example, use ?expand=experiments to include the experiments field in the response. By default, this field is not included in the response.

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Query Parameters

projectKey*string

The project key

Formatstring
environmentKey*string

The environment key

Formatstring
applicationKey?string

Comma separated list of application keys

Formatstring
query?string

Filter events by flag key

Formatstring
impactSize?string

Filter events by impact size. A small impact created a less than 20% change in the proportion of end users receiving one or more flag variations. A medium impact created between a 20%-80% change. A large impact created a more than 80% change. Options: none, small, medium, large

Formatstring
hasExperiments?boolean

Filter events to those associated with an experiment (true) or without an experiment (false)

Formatboolean
global?string

Filter to include or exclude global events. Default value is include. Options: include, exclude

Formatstring
expand?string

Expand properties in response. Options: experiments

Formatstring
limit?integer

The number of deployments to return. Default is 20. Maximum allowed is 100.

Formatint64
from?integer

Unix timestamp in milliseconds. Default value is 7 days ago.

Formatint64
to?integer

Unix timestamp in milliseconds. Default value is now.

Formatint64
after?string

Identifier used for pagination

Formatstring
before?string

Identifier used for pagination

Formatstring

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/engineering-insights/flag-events?projectKey=string&environmentKey=string"
{  "totalCount": 1200,  "items": [    {      "id": "e3b2b0e0-9e9b-4c9a-8e9a-0e0e0e0e0e0e",      "projectId": "65baa44ecc4b5bce113bb4f7",      "projectKey": "default",      "environmentId": "65baa44ecc4b5bce113bb4f7",      "environmentKey": "production",      "flagKey": "enable-new-payment-method",      "eventType": "enabled_targeting",      "eventTime": "1616425200000",      "description": "Targeting rule enabled",      "auditLogEntryId": "e3b2b0e0-9e9b-4c9a-8e9a-0e0e0e0e0e0e",      "member": {        "id": "65baa44ecc4b5bce113bb4f7",        "email": "test@launchdarkly.com",        "firstName": "string",        "lastName": "string"      },      "actions": [        "string"      ],      "impact": {        "size": "medium",        "percentage": 50,        "reason": "evaluations",        "evaluationsSummary": {          "variations": [            {              "value": "true",              "before": 1000,              "after": 500            }          ]        }      },      "experiments": {        "totalCount": 1,        "items": [          {            "key": "experiment-1",            "name": "Experiment 1",            "iteration": {              "id": "65baa44ecc4b5bce113bb4f7",              "status": "running",              "startedAt": "1655314200000",              "endedAt": "1656610200000",              "_links": {                "property1": {                  "href": "string",                  "type": "string"                },                "property2": {                  "href": "string",                  "type": "string"                }              }            },            "_links": {              "property1": {                "href": "string",                "type": "string"              },              "property2": {                "href": "string",                "type": "string"              }            }          }        ]      }    }  ],  "_links": {    "next": {      "href": "/api/v2/engineering-insights/flag-events?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",      "type": "application/json"    },    "self": {      "href": "/api/v2/engineering-insights/flag-events",      "type": "application/json"    }  }}

Update deployment PATCH

Update a deployment by ID. Updating a deployment uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).<br/><br/>The deployment ID is returned as part of the [List deployments](https://launchdarkly.com/docs/api/insights-deployments-beta/get-deployments) response. It is the `id` field of each element in the `items` array.

Create insight group POST

Create insight group