Update a custom metric definition
Replaces the definition in full, so an omitted optional field is cleared. Only PUBLIC_API metrics can be updated through the API. API key must have the Configure Eng Intelligence custom metrics permission.
Authorizations
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Path Parameters
Key of the custom metric
Body
The full replacement state for a custom metric
Display name
"Deploy frequency"
Whether a higher value is better. Defaults to NEUTRAL.
POSITIVE, NEGATIVE, NEUTRAL Free-text group for the metric
"Delivery"
What the metric measures
A draft metric still accepts data points but is hidden from Eng Intelligence. Defaults to false.
Response
The updated custom metric definition
A custom metric defined in the workspace
A draft metric is hidden from Eng Intelligence
Unique key that data points are recorded against
"deploy-frequency"
Display name
"Deploy frequency"
PUBLIC_API metrics take data points through the API. CQL metrics compute their values from a CQL expression and are read-only through the API.
CQL, PUBLIC_API Whether a higher value is better
POSITIVE, NEGATIVE, NEUTRAL Free-text group for the metric
"Delivery"
The CQL expression behind a CQL metric. Null for PUBLIC_API.
What the metric measures