provider Insights flag events (beta) GET
/api/v2/engineering-insights/flag-events @utdk/launchdarkly
/api/v2/engineering-insights/flag-events 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.
- projectKey query required
- The project key
- string
- environmentKey query required
- The environment key
- string
- applicationKey query
- Comma separated list of application keys
- string
- query query
- Filter events by flag key
- string
- impactSize query
- 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`
- string
- hasExperiments query
- Filter events to those associated with an experiment (`true`) or without an experiment (`false`)
- boolean
- global query
- Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude`
- string
- expand query
- Expand properties in response. Options: `experiments`
- string
- limit query
- The number of deployments to return. Default is 20. Maximum allowed is 100.
- integer
- from query
- Unix timestamp in milliseconds. Default value is 7 days ago.
- integer
- to query
- Unix timestamp in milliseconds. Default value is now.
- integer
- after query
- Identifier used for pagination
- string
- before query
- Identifier used for pagination
- string
Try it
Authentication
Configure credentials for LaunchDarkly REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import launchdarkly from '@utdk/launchdarkly';
await launchdarkly.getflagevents()