v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Insights flag events (beta)

List 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.

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

Query parameters

projectKeystring string required

The project key

environmentKeystring string required

The environment key

applicationKeystring string

Comma separated list of application keys

querystring string

Filter events by flag key

impactSizestring 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

hasExperimentsboolean

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

globalstring string

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

expandstring string

Expand properties in response. Options: experiments

limitinteger

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

frominteger

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

tointeger

Unix timestamp in milliseconds. Default value is now.

afterstring string

Identifier used for pagination

beforestring string

Identifier used for pagination

Response

Flag event collection response

totalCountinteger required

The total number of flag events

_linksobject

The location and content type of related resources

Example response

{
  "totalCount": 1200,
  "items": [
    {
      "id": "e3b2b0e0-9e9b-4c9a-8e9a-0e0e0e0e0e0e",
      "projectId": "65baa44ecc4b5bce113bb4f7",
      "projectKey": "default",
      "environmentId": "65baa44ecc4b5bce113bb4f7",
      "environmentKey": "production",
      "flagKey": "enable-new-payment-method",
      "description": "Targeting rule enabled",
      "auditLogEntryId": "e3b2b0e0-9e9b-4c9a-8e9a-0e0e0e0e0e0e",
      "member": {
        "id": "65baa44ecc4b5bce113bb4f7",
        "email": "test@launchdarkly.com"
      },
      "impact": {
        "size": "medium",
        "percentage": 50,
        "evaluationsSummary": {
          "variations": [
            {
              "value": "true",
              "before": 1000,
              "after": 500
            }
          ]
        }
      },
      "experiments": {
        "totalCount": 1,
        "items": [
          {
            "key": "experiment-1",
            "name": "Experiment 1",
            "iteration": {
              "id": "65baa44ecc4b5bce113bb4f7"
            }
          }
        ]
      }
    }
  ],
  "_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"
    }
  }
}