LaunchDarkly REST API
LaunchDarkly DocsSign in
HomeAPI ReferenceSDKsContext Plugin
Insights scores (beta)

Get insight group

GET
/api/v2/engineering-insights/insights/groups/{insightGroupKey}

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.

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Path Parameters

insightGroupKey*string

The insight group key

Formatstring

Query Parameters

expand?string

Options: scores, environment

Formatstring

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/engineering-insights/insights/groups/string"
{  "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"}

List insight groups GET

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.

Patch insight group PATCH

Update an insight group. Updating an insight group uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).