Insights flag events (beta)

This feature is in beta

To use this feature, pass in a header including the LD-API-Version key with value set to beta. Use this header with each call. To learn more, read Beta resources.

Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible.

The flag events API provides access to flag-event data used in engineering insights project metrics. To learn more, read Flag health.

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.

Request

query Parameters

projectKey required	string <string> The project key
environmentKey required	string <string> The environment key
applicationKey	string <string> Comma separated list of application keys
query	string <string> Filter events by flag key
impactSize	string <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`
hasExperiments	boolean <boolean> Filter events to those associated with an experiment (`true`) or without an experiment (`false`)
global	string <string> Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude`
expand	string <string> Expand properties in response. Options: `experiments`
limit	integer <int64> The number of deployments to return. Default is 20. Maximum allowed is 100.
from	integer <int64> Unix timestamp in milliseconds. Default value is 7 days ago.
to	integer <int64> Unix timestamp in milliseconds. Default value is now.
after	string <string> Identifier used for pagination
before	string <string> Identifier used for pagination

Responses

200

Flag event collection response

400

Invalid request

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

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

Request samples

curl
Node.js
Python

Response samples

application/json

{"totalCount": 1200,
"items": [{"id": "e3b2b0e0-9e9b-4c9a-8e9a-0e0e0e0e0e0e",
"projectId": "65baa44ecc4b5bce113bb4f7",
"projectKey": "default",
"environmentId": "65baa44ecc4b5bce113bb4f7",
"environmentKey": "production",
"flagKey": "enable-new-payment-method",
"eventType": "string",
"eventTime": 0,
"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": "string",
"evaluationsSummary": {"variations": [{"value": "true",
"before": 1000,
"after": 500
}
]
}
},
"experiments": {"totalCount": 1,
"items": [{"key": "experiment-1",
"name": "Experiment 1",
"iteration": {"id": "65baa44ecc4b5bce113bb4f7",
"status": "string",
"startedAt": 0,
"endedAt": 0,
"_links": {"property1": null,
"property2": null
}
},
"_links": {"property1": {"href": null,
"type": null
},
"property2": {"href": null,
"type": null
}
}
}
]
}
}
],
"_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"
}
}
}

➔ Next to Insights pull requests (beta)