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

Headers

AuthorizationstringRequired

Query parameters

projectKeystringRequired
The project key
environmentKeystringRequired
The environment key
applicationKeystringOptional
Comma separated list of application keys
querystringOptional
Filter events by flag key
impactSizestringOptional

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)

globalstringOptional

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

expandstringOptional

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.
afterstringOptional
Identifier used for pagination
beforestringOptional
Identifier used for pagination

Response

Flag event collection response
totalCountinteger
The total number of flag events
itemslist of objects
A list of flag events

Errors