Sign in
Insights scores (beta)

Patch insight group

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

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

Path parameters

insightGroupKeystring string required

The insight group key

The insight group key

Request body

opstring required

The type of operation to perform

pathstring required

A JSON Pointer string specifying the part of the document to operate on

valuestring

A JSON value used in "add", "replace", and "test" operations

Example request

[
  {
    "op": "replace",
    "path": "/exampleField",
    "value": "new example value"
  }
]

Response

Insight group response

keystring required

The insight group key

namestring required

The insight group name

projectKeystring required

The project key

environmentKeystring required

The environment key

applicationKeysstring[]

The application keys

createdAtinteger required

Example response

{
  "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": [
        {
          "reason": {
            "resources": [
              "proj/*:env/*;qa_*:/flag/*"
            ],
            "actions": [
              "*"
            ],
            "effect": "allow"
          }
        }
      ],
      "allowed": [
        {
          "reason": {
            "resources": [
              "proj/*:env/*;qa_*:/flag/*"
            ],
            "actions": [
              "*"
            ],
            "effect": "allow"
          }
        }
      ]
    },
    "requireComments": true,
    "confirmChanges": true,
    "tags": [
      "ops"
    ],
    "approvalSettings": {
      "required": true,
      "minNumApprovals": 1,
      "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"
      ],
      "indicatorRange": {
        "max": 100
      }
    },
    "deploymentFrequency": {
      "score": 100,
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "indicatorRange": {
        "max": 100
      }
    },
    "deploymentFailureRate": {
      "score": 100,
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "indicatorRange": {
        "max": 100
      }
    },
    "leadTime": {
      "score": 100,
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "indicatorRange": {
        "max": 100
      }
    },
    "impactSize": {
      "score": 100,
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "indicatorRange": {
        "max": 100
      }
    },
    "experimentationCoverage": {
      "score": 100,
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "indicatorRange": {
        "max": 100
      }
    },
    "flagHealth": {
      "score": 100,
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "indicatorRange": {
        "max": 100
      }
    },
    "velocity": {
      "score": 100,
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "indicatorRange": {
        "max": 100
      }
    },
    "risk": {
      "score": 100,
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "indicatorRange": {
        "max": 100
      }
    },
    "efficiency": {
      "score": 100,
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "indicatorRange": {
        "max": 100
      }
    },
    "creationRatio": {
      "score": 100,
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "indicatorRange": {
        "max": 100
      }
    }
  },
  "key": "default-production-all-apps",
  "name": "Production - All Apps",
  "projectKey": "default",
  "environmentKey": "production",
  "applicationKeys": [
    "billing-service",
    "inventory-service"
  ]
}

Changes