Skip to main content
PATCH
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

metricGroupId
string
required

The ID of the Metric Group to update.

Example:

"612"

Body

application/json
name
string

The new name of the Metric Group.

Minimum string length: 1
description
string

The new description of the Metric Group.

metricIds
string[]

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

The ID of the Metric.

Response

Metric Group updated successfully.

A Metric Group is a named collection of Metrics within a Project, used to score or compare records with a consistent set of Metrics.

id
string
required

The ID of the Metric Group.

projectId
string
required

The ID of the Project the Metric Group belongs to.

name
string
required

The name of the Metric Group.

description
string
required

The description of the Metric Group.

metricIds
string[]
required

The IDs of the Metrics in the group.

createdAt
string
required

The ISO 8601 timestamp when the Metric Group was created.

updatedAt
string
required

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