List insight 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:
scoresincludes details on all of the scores used in the engineering insights metrics views for each groupenvironmentincludes details on each environment associated with each groupmetadataincludes 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.
Authorization
ApiKey read, writeIn: header
Scope: read, write
Query Parameters
The number of insight groups to return. Default is 20. Must be between 1 and 20 inclusive.
int64Where 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.
int64Sort flag list by field. Prefix field with - to sort in descending order. Allowed fields: name
stringFilter list of insights groups by name.
stringOptions: scores, environment, metadata
stringResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v2/engineering-insights/insights/groups"{ "totalCount": 15, "items": [ { "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, "_access": { "denied": [ { "action": "string", "reason": { "resources": [ "proj/*:env/*;qa_*:/flag/*" ], "notResources": [ "string" ], "actions": [ "*" ], "notActions": [ "string" ], "effect": "allow", "role_name": "string" } } ], "allowed": [ { "action": "string", "reason": { "resources": [ "proj/*:env/*;qa_*:/flag/*" ], "notResources": [ "string" ], "actions": [ "*" ], "notActions": [ "string" ], "effect": "allow", "role_name": "string" } } ] }, "defaultTrackEvents": false, "requireComments": true, "confirmChanges": true, "tags": [ "ops" ], "approvalSettings": { "required": true, "bypassApprovalsForPendingChanges": false, "minNumApprovals": 1, "canReviewOwnRequest": false, "canApplyDeclinedChanges": true, "autoApplyApprovedChanges": true, "serviceKind": "launchdarkly", "serviceConfig": {}, "requiredApprovalTags": [ "require-approval" ], "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258" }, "resourceApprovalSettings": { "property1": { "required": true, "bypassApprovalsForPendingChanges": false, "minNumApprovals": 1, "canReviewOwnRequest": false, "canApplyDeclinedChanges": true, "autoApplyApprovedChanges": true, "serviceKind": "launchdarkly", "serviceConfig": {}, "requiredApprovalTags": [ "require-approval" ], "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258" }, "property2": { "required": true, "bypassApprovalsForPendingChanges": false, "minNumApprovals": 1, "canReviewOwnRequest": false, "canApplyDeclinedChanges": true, "autoApplyApprovedChanges": true, "serviceKind": "launchdarkly", "serviceConfig": {}, "requiredApprovalTags": [ "require-approval" ], "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258" } }, "critical": true }, "scores": { "overall": { "score": 100, "aggregateOf": [ "deploymentFrequency", "leadTime" ], "diffVsLastPeriod": 0, "indicator": "excellent", "indicatorRange": { "min": 0, "max": 100 }, "lastPeriod": {} }, "deploymentFrequency": { "score": 100, "aggregateOf": [ "deploymentFrequency", "leadTime" ], "diffVsLastPeriod": 0, "indicator": "excellent", "indicatorRange": { "min": 0, "max": 100 }, "lastPeriod": {} }, "deploymentFailureRate": { "score": 100, "aggregateOf": [ "deploymentFrequency", "leadTime" ], "diffVsLastPeriod": 0, "indicator": "excellent", "indicatorRange": { "min": 0, "max": 100 }, "lastPeriod": {} }, "leadTime": { "score": 100, "aggregateOf": [ "deploymentFrequency", "leadTime" ], "diffVsLastPeriod": 0, "indicator": "excellent", "indicatorRange": { "min": 0, "max": 100 }, "lastPeriod": {} }, "impactSize": { "score": 100, "aggregateOf": [ "deploymentFrequency", "leadTime" ], "diffVsLastPeriod": 0, "indicator": "excellent", "indicatorRange": { "min": 0, "max": 100 }, "lastPeriod": {} }, "experimentationCoverage": { "score": 100, "aggregateOf": [ "deploymentFrequency", "leadTime" ], "diffVsLastPeriod": 0, "indicator": "excellent", "indicatorRange": { "min": 0, "max": 100 }, "lastPeriod": {} }, "flagHealth": { "score": 100, "aggregateOf": [ "deploymentFrequency", "leadTime" ], "diffVsLastPeriod": 0, "indicator": "excellent", "indicatorRange": { "min": 0, "max": 100 }, "lastPeriod": {} }, "velocity": { "score": 100, "aggregateOf": [ "deploymentFrequency", "leadTime" ], "diffVsLastPeriod": 0, "indicator": "excellent", "indicatorRange": { "min": 0, "max": 100 }, "lastPeriod": {} }, "risk": { "score": 100, "aggregateOf": [ "deploymentFrequency", "leadTime" ], "diffVsLastPeriod": 0, "indicator": "excellent", "indicatorRange": { "min": 0, "max": 100 }, "lastPeriod": {} }, "efficiency": { "score": 100, "aggregateOf": [ "deploymentFrequency", "leadTime" ], "diffVsLastPeriod": 0, "indicator": "excellent", "indicatorRange": { "min": 0, "max": 100 }, "lastPeriod": {} }, "creationRatio": { "score": 100, "aggregateOf": [ "deploymentFrequency", "leadTime" ], "diffVsLastPeriod": 0, "indicator": "excellent", "indicatorRange": { "min": 0, "max": 100 }, "lastPeriod": {} } }, "scoreMetadata": { "period": { "startTime": "1706701522000", "endTime": "1706701522000" }, "lastPeriod": { "startTime": "1706701522000", "endTime": "1706701522000" } }, "key": "default-production-all-apps", "name": "Production - All Apps", "projectKey": "default", "environmentKey": "production", "applicationKeys": [ "billing-service", "inventory-service" ], "createdAt": "1706701522000" } ], "_links": { "property1": { "href": "string", "type": "string" }, "property2": { "href": "string", "type": "string" } }, "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" } }}Create insight group POST
Create insight group
Get insight group GET
Get insight group ### Expanding the insight group response LaunchDarkly supports expanding the insight group 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 this group * `environment` includes details on each environment associated with this group For example, use `?expand=scores` to include the `scores` field in the response. By default, this field is **not** included in the response.