Retrieve a custom metric definition
API key must have the View Eng Intelligence permission. A draft metric returns 404 unless the key also has 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
Response
The 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