List insight groups

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

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.

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

List insight groups

cURL

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/engineering-insights/insights/groups \
  --header 'Authorization: <api-key>'

200

{
  "totalCount": 15,
  "items": [
    {
      "key": "default-production-all-apps",
      "name": "Production - All Apps",
      "projectKey": "default",
      "environmentKey": "production",
      "createdAt": "1706701522000",
      "environment": {
        "_links": {
          "self": {
            "href": "/api/v2/projects/my-project/environments/my-environment",
            "type": "application/json"
          }
        },
        "_id": "57be1db38b75bf0772d11384",
        "key": "environment-key-123abc",
        "name": "My Environment",
        "apiKey": "sdk-xxx",
        "mobileKey": "mob-xxx",
        "color": "F5A623",
        "defaultTtl": 5,
        "secureMode": true,
        "defaultTrackEvents": false,
        "requireComments": true,
        "confirmChanges": true,
        "tags": [
          "ops"
        ],
        "critical": true,
        "_access": {
          "denied": [
            {
              "action": "<string>",
              "reason": {
                "effect": "allow",
                "resources": [
                  "proj/*:env/*;qa_*:/flag/*"
                ],
                "notResources": [
                  "<string>"
                ],
                "actions": [
                  "*"
                ],
                "notActions": [
                  "<string>"
                ],
                "role_name": "<string>"
              }
            }
          ],
          "allowed": [
            {
              "action": "<string>",
              "reason": {
                "effect": "allow",
                "resources": [
                  "proj/*:env/*;qa_*:/flag/*"
                ],
                "notResources": [
                  "<string>"
                ],
                "actions": [
                  "*"
                ],
                "notActions": [
                  "<string>"
                ],
                "role_name": "<string>"
              }
            }
          ]
        },
        "approvalSettings": {
          "required": true,
          "bypassApprovalsForPendingChanges": false,
          "minNumApprovals": 1,
          "canReviewOwnRequest": false,
          "canApplyDeclinedChanges": true,
          "serviceKind": "launchdarkly",
          "serviceConfig": {},
          "requiredApprovalTags": [
            "require-approval"
          ],
          "autoApplyApprovedChanges": true,
          "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
        },
        "resourceApprovalSettings": {}
      },
      "scores": {
        "overall": {
          "score": 100,
          "indicator": "excellent",
          "indicatorRange": {
            "min": 0,
            "max": 100
          },
          "aggregateOf": [
            "deploymentFrequency",
            "leadTime"
          ],
          "diffVsLastPeriod": 123,
          "lastPeriod": "<unknown>"
        },
        "deploymentFrequency": {
          "score": 100,
          "indicator": "excellent",
          "indicatorRange": {
            "min": 0,
            "max": 100
          },
          "aggregateOf": [
            "deploymentFrequency",
            "leadTime"
          ],
          "diffVsLastPeriod": 123,
          "lastPeriod": "<unknown>"
        },
        "deploymentFailureRate": {
          "score": 100,
          "indicator": "excellent",
          "indicatorRange": {
            "min": 0,
            "max": 100
          },
          "aggregateOf": [
            "deploymentFrequency",
            "leadTime"
          ],
          "diffVsLastPeriod": 123,
          "lastPeriod": "<unknown>"
        },
        "leadTime": {
          "score": 100,
          "indicator": "excellent",
          "indicatorRange": {
            "min": 0,
            "max": 100
          },
          "aggregateOf": [
            "deploymentFrequency",
            "leadTime"
          ],
          "diffVsLastPeriod": 123,
          "lastPeriod": "<unknown>"
        },
        "impactSize": {
          "score": 100,
          "indicator": "excellent",
          "indicatorRange": {
            "min": 0,
            "max": 100
          },
          "aggregateOf": [
            "deploymentFrequency",
            "leadTime"
          ],
          "diffVsLastPeriod": 123,
          "lastPeriod": "<unknown>"
        },
        "experimentationCoverage": {
          "score": 100,
          "indicator": "excellent",
          "indicatorRange": {
            "min": 0,
            "max": 100
          },
          "aggregateOf": [
            "deploymentFrequency",
            "leadTime"
          ],
          "diffVsLastPeriod": 123,
          "lastPeriod": "<unknown>"
        },
        "flagHealth": {
          "score": 100,
          "indicator": "excellent",
          "indicatorRange": {
            "min": 0,
            "max": 100
          },
          "aggregateOf": [
            "deploymentFrequency",
            "leadTime"
          ],
          "diffVsLastPeriod": 123,
          "lastPeriod": "<unknown>"
        },
        "velocity": {
          "score": 100,
          "indicator": "excellent",
          "indicatorRange": {
            "min": 0,
            "max": 100
          },
          "aggregateOf": [
            "deploymentFrequency",
            "leadTime"
          ],
          "diffVsLastPeriod": 123,
          "lastPeriod": "<unknown>"
        },
        "risk": {
          "score": 100,
          "indicator": "excellent",
          "indicatorRange": {
            "min": 0,
            "max": 100
          },
          "aggregateOf": [
            "deploymentFrequency",
            "leadTime"
          ],
          "diffVsLastPeriod": 123,
          "lastPeriod": "<unknown>"
        },
        "efficiency": {
          "score": 100,
          "indicator": "excellent",
          "indicatorRange": {
            "min": 0,
            "max": 100
          },
          "aggregateOf": [
            "deploymentFrequency",
            "leadTime"
          ],
          "diffVsLastPeriod": 123,
          "lastPeriod": "<unknown>"
        },
        "creationRatio": {
          "score": 100,
          "indicator": "excellent",
          "indicatorRange": {
            "min": 0,
            "max": 100
          },
          "aggregateOf": [
            "deploymentFrequency",
            "leadTime"
          ],
          "diffVsLastPeriod": 123,
          "lastPeriod": "<unknown>"
        }
      },
      "scoreMetadata": {
        "period": {
          "startTime": "1706701522000",
          "endTime": "1706701522000"
        },
        "lastPeriod": {
          "startTime": "1706701522000",
          "endTime": "1706701522000"
        }
      },
      "applicationKeys": [
        "billing-service",
        "inventory-service"
      ]
    }
  ],
  "_links": {},
  "metadata": {
    "countByIndicator": {
      "excellent": 1,
      "good": 1,
      "fair": 1,
      "needsAttention": 1,
      "notCalculated": 1,
      "unknown": 1,
      "total": 6
    }
  },
  "scoreMetadata": {
    "period": {
      "startTime": "1706701522000",
      "endTime": "1706701522000"
    },
    "lastPeriod": {
      "startTime": "1706701522000",
      "endTime": "1706701522000"
    }
  }
}

Authorizations

Authorization · string · header · required

Query Parameters

limit · integer<int64>

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

offset · integer<int64>

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.

sort · string<string>

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

query · string<string>

Filter list of insights groups by name.

expand · string<string>

Options: scores, environment, metadata

Response

200

application/json

Insight groups collection response

totalCount · integer · required

The total number of insight groups

Example:

15

items · object[] · required

A list of insight groups

Show child attributes

_links · object

The location and content type of related resources

Show child attributes

metadata · object

Metadata about the insight groups

Show child attributes

scoreMetadata · object

Metadata about the insight scores, when expanded

Show child attributes