Create a custom metric definition
Defines a custom metric of type PUBLIC_API, which you then record data points against. The key cannot change after creation. 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.
Body
A custom metric to define
Unique key that data points are recorded against. Letters, digits, and hyphens, 2 to 255 characters, starting and ending with a letter or digit.
"deploy-frequency"
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 created 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