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

Patch insight group

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

Integration Audit Log Subscriptions

Next
Built with

Update an insight group. Updating an insight group uses a JSON patch representation of the desired changes. To learn more, read Updates.

Authentication

Authorizationstring
API Key authentication via header

Path parameters

insightGroupKeystringRequiredformat: "string"
The insight group key

Request

This endpoint expects a list of objects.
opstringRequired
The type of operation to perform
pathstringRequired
A JSON Pointer string specifying the part of the document to operate on
valueanyOptional
A JSON value used in "add", "replace", and "test" operations

Response

Insight group response
keystring
The insight group key
namestring
The insight group name
projectKeystring
The project key
environmentKeystring
The environment key
createdAtlong
The time the insight group was created
environmentobject
Expanded details about the environment
scoresobject
The scores for the insight group
scoreMetadataobject
Metadata about the insight scores, when expanded
applicationKeyslist of strings
The application keys

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error