SCscorecard-ai

Update Metric Group

Changed on

Update a Metric Group's name, description, or member Metrics. The metricIds array replaces the group's current set of Metrics.

patch/metric-groups/{metricGroupId}

Request

  • Base URL
    https://api2.scorecard.io/api/v2
  • Auth
    HTTP bearer

Path parameters

metricGroupIdstring required
Example:612

The ID of the Metric Group to update.

Request body

namestring

The new name of the Metric Group.

descriptionstring

The new description of the Metric Group.

metricIdsstring[]

The new set of Metric IDs for the group, replacing the current set. Every Metric must belong to the same Project as the group.

Example request

{
  "metricIds": [
    "321"
  ]
}

Response

Metric Group updated successfully.

idstring required

The ID of the Metric Group.

projectIdstring required

The ID of the Project the Metric Group belongs to.

namestring required

The name of the Metric Group.

descriptionstring required

The description of the Metric Group.

metricIdsstring[] required

The IDs of the Metrics in the group.

createdAtstring required

The ISO 8601 timestamp when the Metric Group was created.

updatedAtstring required

The ISO 8601 timestamp when the Metric Group was last updated.

Changes