For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inTry it free
DocsGuidesSDKsIntegrationsAPI docsTutorialsFlagship blog
DocsGuidesSDKsIntegrationsAPI docsTutorialsFlagship blog
  • REST API overview
    • Access Tokens
    • Account Members
    • Account Usage Beta
    • AI Configs
    • Announcements
    • Applications Beta
    • Approvals
    • Approvals Beta
    • Audit Log
    • Code References
    • Contexts
    • Context Settings
    • Custom Roles
    • Data Export Destinations
    • Environments
    • Experiments
    • Feature Flags
    • Feature Flags Beta
    • Flag Import Configurations Beta
    • Flag Links Beta
    • Flag Triggers
    • Follow Flags
    • Holdouts Beta
    • Insights Charts Beta
    • Insights Deployments Beta
    • Insights Flag Events Beta
    • Insights Pull Requests Beta
    • Insights Repositories Beta
    • Insights Scores Beta
      • POSTCreate insight group
      • DELDelete insight group
      • GETGet insight group
      • GETGet insight scores
      • GETList insight groups
      • PATCHPatch insight group
    • Integration Audit Log Subscriptions
    • Integration Delivery Configurations Beta
    • Integrations Beta
    • Layers
    • Metrics
    • Metrics Beta
    • OAuth2 Clients
    • Persistent Store Integrations Beta
    • Projects
    • Relay Proxy Configurations
    • Release Pipelines Beta
    • Releases Beta
    • Scheduled Changes
    • Segments
    • Tags
    • Teams
    • Teams Beta
    • Users
    • Users Beta
    • User Settings
    • Views Beta
    • Webhooks
    • Workflows
    • Workflow Templates
    • Other
Sign inTry it free
LogoLogo
REST API overviewInsights Scores Beta

List insight groups

GET
/api/v2/engineering-insights/insights/groups
GET
/api/v2/engineering-insights/insights/groups
$curl https://app.launchdarkly.com/api/v2/engineering-insights/insights/groups \
> -H "Authorization: <apiKey>"
1{
2 "totalCount": 15,
3 "items": [
4 {
5 "key": "default-production-all-apps",
6 "name": "Production - All Apps",
7 "projectKey": "default",
8 "environmentKey": "production",
9 "createdAt": 1706701522000,
10 "environment": {
11 "_links": {
12 "self": {
13 "href": "/api/v2/projects/my-project/environments/my-environment",
14 "type": "application/json"
15 }
16 },
17 "_id": "57be1db38b75bf0772d11384",
18 "key": "environment-key-123abc",
19 "name": "My Environment",
20 "apiKey": "sdk-xxx",
21 "mobileKey": "mob-xxx",
22 "color": "F5A623",
23 "defaultTtl": 5,
24 "secureMode": true,
25 "defaultTrackEvents": false,
26 "requireComments": true,
27 "confirmChanges": true,
28 "tags": [
29 "ops"
30 ],
31 "critical": true,
32 "_access": {
33 "denied": [
34 {
35 "action": "string",
36 "reason": {
37 "effect": "allow",
38 "resources": [
39 "proj/*:env/*;qa_*:/flag/*"
40 ],
41 "notResources": [
42 "string"
43 ],
44 "actions": [
45 "*"
46 ],
47 "notActions": [
48 "string"
49 ],
50 "role_name": "string"
51 }
52 }
53 ],
54 "allowed": [
55 {
56 "action": "string",
57 "reason": {
58 "effect": "allow",
59 "resources": [
60 "proj/*:env/*;qa_*:/flag/*"
61 ],
62 "notResources": [
63 "string"
64 ],
65 "actions": [
66 "*"
67 ],
68 "notActions": [
69 "string"
70 ],
71 "role_name": "string"
72 }
73 }
74 ]
75 },
76 "approvalSettings": {
77 "required": true,
78 "bypassApprovalsForPendingChanges": false,
79 "minNumApprovals": 1,
80 "canReviewOwnRequest": false,
81 "canApplyDeclinedChanges": true,
82 "serviceKind": "launchdarkly",
83 "serviceConfig": {},
84 "requiredApprovalTags": [
85 "require-approval"
86 ],
87 "autoApplyApprovedChanges": true,
88 "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
89 },
90 "resourceApprovalSettings": {}
91 },
92 "scores": {
93 "overall": {
94 "score": 100,
95 "indicator": "excellent",
96 "indicatorRange": {
97 "min": 0,
98 "max": 100
99 },
100 "aggregateOf": [
101 "deploymentFrequency",
102 "leadTime"
103 ],
104 "diffVsLastPeriod": 1
105 },
106 "deploymentFrequency": {
107 "score": 100,
108 "indicator": "excellent",
109 "indicatorRange": {
110 "min": 0,
111 "max": 100
112 },
113 "aggregateOf": [
114 "deploymentFrequency",
115 "leadTime"
116 ],
117 "diffVsLastPeriod": 1
118 },
119 "deploymentFailureRate": {
120 "score": 100,
121 "indicator": "excellent",
122 "indicatorRange": {
123 "min": 0,
124 "max": 100
125 },
126 "aggregateOf": [
127 "deploymentFrequency",
128 "leadTime"
129 ],
130 "diffVsLastPeriod": 1
131 },
132 "leadTime": {
133 "score": 100,
134 "indicator": "excellent",
135 "indicatorRange": {
136 "min": 0,
137 "max": 100
138 },
139 "aggregateOf": [
140 "deploymentFrequency",
141 "leadTime"
142 ],
143 "diffVsLastPeriod": 1
144 },
145 "impactSize": {
146 "score": 100,
147 "indicator": "excellent",
148 "indicatorRange": {
149 "min": 0,
150 "max": 100
151 },
152 "aggregateOf": [
153 "deploymentFrequency",
154 "leadTime"
155 ],
156 "diffVsLastPeriod": 1
157 },
158 "experimentationCoverage": {
159 "score": 100,
160 "indicator": "excellent",
161 "indicatorRange": {
162 "min": 0,
163 "max": 100
164 },
165 "aggregateOf": [
166 "deploymentFrequency",
167 "leadTime"
168 ],
169 "diffVsLastPeriod": 1
170 },
171 "flagHealth": {
172 "score": 100,
173 "indicator": "excellent",
174 "indicatorRange": {
175 "min": 0,
176 "max": 100
177 },
178 "aggregateOf": [
179 "deploymentFrequency",
180 "leadTime"
181 ],
182 "diffVsLastPeriod": 1
183 },
184 "velocity": {
185 "score": 100,
186 "indicator": "excellent",
187 "indicatorRange": {
188 "min": 0,
189 "max": 100
190 },
191 "aggregateOf": [
192 "deploymentFrequency",
193 "leadTime"
194 ],
195 "diffVsLastPeriod": 1
196 },
197 "risk": {
198 "score": 100,
199 "indicator": "excellent",
200 "indicatorRange": {
201 "min": 0,
202 "max": 100
203 },
204 "aggregateOf": [
205 "deploymentFrequency",
206 "leadTime"
207 ],
208 "diffVsLastPeriod": 1
209 },
210 "efficiency": {
211 "score": 100,
212 "indicator": "excellent",
213 "indicatorRange": {
214 "min": 0,
215 "max": 100
216 },
217 "aggregateOf": [
218 "deploymentFrequency",
219 "leadTime"
220 ],
221 "diffVsLastPeriod": 1
222 },
223 "creationRatio": {
224 "score": 100,
225 "indicator": "excellent",
226 "indicatorRange": {
227 "min": 0,
228 "max": 100
229 },
230 "aggregateOf": [
231 "deploymentFrequency",
232 "leadTime"
233 ],
234 "diffVsLastPeriod": 1
235 }
236 },
237 "scoreMetadata": {
238 "period": {
239 "startTime": 1706701522000,
240 "endTime": 1706701522000
241 },
242 "lastPeriod": {
243 "startTime": 1706701522000,
244 "endTime": 1706701522000
245 }
246 },
247 "applicationKeys": [
248 "billing-service",
249 "inventory-service"
250 ]
251 }
252 ],
253 "_links": {},
254 "metadata": {
255 "countByIndicator": {
256 "excellent": 1,
257 "good": 1,
258 "fair": 1,
259 "needsAttention": 1,
260 "notCalculated": 1,
261 "unknown": 1,
262 "total": 6
263 }
264 },
265 "scoreMetadata": {
266 "period": {
267 "startTime": 1706701522000,
268 "endTime": 1706701522000
269 },
270 "lastPeriod": {
271 "startTime": 1706701522000,
272 "endTime": 1706701522000
273 }
274 }
275}
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.
Was this page helpful?
Previous

Patch insight group

Next
Built with

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.

Authentication

Authorizationstring
API Key authentication via header

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.

sortstringOptionalformat: "string"

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

querystringOptionalformat: "string"
Filter list of insights groups by name.
expandstringOptionalformat: "string"

Options: scores, environment, metadata

Response

Insight groups collection response
totalCountinteger
The total number of insight groups
itemslist of objects
A list of insight groups
_linksmap from strings to objects
The location and content type of related resources
metadataobject
Metadata about the insight groups
scoreMetadataobject
Metadata about the insight scores, when expanded

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error