List flag events

GET

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

GET

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

curl -G https://app.launchdarkly.com/api/v2/engineering-insights/flag-events \
     -H "Authorization: <apiKey>" \
     -d environmentKey=environmentKey \
     -d projectKey=projectKey

{
  "totalCount": 1200,
  "items": [
    {
      "id": "e3b2b0e0-9e9b-4c9a-8e9a-0e0e0e0e0e0e",
      "projectId": "65baa44ecc4b5bce113bb4f7",
      "projectKey": "default",
      "flagKey": "enable-new-payment-method",
      "eventType": "enabled_targeting",
      "eventTime": 1616425200000,
      "description": "Targeting rule enabled",
      "impact": {
        "size": "medium",
        "percentage": 50,
        "reason": "evaluations",
        "evaluationsSummary": {
          "variations": [
            {
              "value": null,
              "before": 1000,
              "after": 500
            }
          ]
        }
      },
      "environmentId": "65baa44ecc4b5bce113bb4f7",
      "environmentKey": "production",
      "auditLogEntryId": "e3b2b0e0-9e9b-4c9a-8e9a-0e0e0e0e0e0e",
      "member": {
        "id": "65baa44ecc4b5bce113bb4f7",
        "email": "test@launchdarkly.com",
        "firstName": "string",
        "lastName": "string"
      },
      "actions": [
        "string"
      ],
      "experiments": {
        "totalCount": 1,
        "items": [
          {
            "key": "experiment-1",
            "name": "Experiment 1",
            "iteration": {
              "id": "65baa44ecc4b5bce113bb4f7",
              "status": "running",
              "startedAt": 1655314200000,
              "endedAt": 1656610200000,
              "_links": {}
            },
            "_links": {}
          }
        ]
      }
    }
  ],
  "_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"
    }
  }
}

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

Authentication

Authorizationstring

API Key authentication via header

Query parameters

projectKeystringRequiredformat: "string"

The project key

environmentKeystringRequiredformat: "string"

The environment key

applicationKeystringOptionalformat: "string"

Comma separated list of application keys

querystringOptionalformat: "string"

Filter events by flag key

impactSizestringOptionalformat: "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

hasExperimentsbooleanOptional

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

globalstringOptionalformat: "string"

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

expandstringOptionalformat: "string"

Expand properties in response. Options: experiments

limitlongOptional

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

fromlongOptional

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

tolongOptional

Unix timestamp in milliseconds. Default value is now.

afterstringOptionalformat: "string"

Identifier used for pagination

beforestringOptionalformat: "string"

Identifier used for pagination

Response

Flag event collection response

totalCountinteger

The total number of flag events

itemslist of objects

A list of flag events

_linksmap from strings to objectsOptional

The location and content type of related resources

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error