List insight groups

GET
/api/v2/engineering-insights/insights/groups

List groups for which you are collecting insights

Expanding the insight groups collection response

LaunchDarkly supports expanding the insight groups collection response to include additional fields.

To expand the response, append the expand query parameter and include the following:

  • scores includes details on all of the scores used in the engineering insights metrics views for each group
  • environment includes details on each environment associated with each group
  • metadata includes counts of the number of insight groups with particular indicators, such as “excellent,” “good,” “fair,” and so on.

For example, use ?expand=scores to include the scores field in the response. By default, this field is not included in the response.

Query parameters

limitlongOptional

The number of insight groups to return. Default is 20. Must be between 1 and 20 inclusive.

offsetlongOptional

Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

sortstringOptional

Sort flag list by field. Prefix field with - to sort in descending order. Allowed fields: name

querystringOptional

Filter list of insights groups by name.

expandstringOptional

Options: scores, environment, metadata

Response

Insight groups collection response

totalCountinteger

The total number of insight groups

itemslist of objects

A list of insight groups

metadataobjectOptional

Metadata about the insight groups

scoreMetadataobjectOptional

Metadata about the insight scores, when expanded

Errors

Built with