Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Path Parameters

projectId
string
required

The ID of the Project to create the Metric Group in.

Example:

"314"

Body

application/json
name
string
required

The name of the Metric Group.

Minimum string length: 1
metricIds
string[]
required

The IDs of the Metrics to include in the group. Every Metric must belong to the same Project as the group.

The ID of the Metric.

description
string

The description of the Metric Group.

Response

Metric Group created 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.