COcortex
Custom Metrics

List custom metric definitions

Changed on

Returns every custom metric defined in the workspace, sorted by key. API key must have the View Eng Intelligence permission. Draft metrics are included only when the key also has the Configure Eng Intelligence custom metrics permission.

get/api/v1/eng-intel/custom-metrics

Request

  • Base URL
    https://api.getcortexapp.com
  • URL
    https://api.getcortexapp.com/api/v1/eng-intel/custom-metrics
  • Auth
    HTTP bearer

Query parameters

pageSizeinteger required

Number of results to return per page, between 1 and 1000. Default 250.

pageinteger required

Page number to return, 0-indexed. Default 0.

Response

A page of custom metric definitions

pageinteger required

Current page number, 0-indexed

totalinteger required

Total number of results

totalPagesinteger required

Total number of pages

Example response

{
  "customMetrics": [
    {
      "category": "Delivery",
      "key": "deploy-frequency",
      "name": "Deploy frequency"
    }
  ]
}

Changes