---
title: "List custom metric definitions"
method: GET
path: "/api/v1/eng-intel/custom-metrics"
tags: ["Custom Metrics"]
---

# List custom metric definitions

`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

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.

## Query parameters

- `pageSize` integer, required
- `page` integer, required

## Response `200`

A page of custom metric definitions

- ListCustomMetricDefinitions: A page of custom metric definitions
  - `customMetrics` CustomMetricDefinition[], required
    - `category` string: Free-text group for the metric
    - `cqlExpression` string: The CQL expression behind a `CQL` metric. Null for `PUBLIC_API`.
    - `description` string: What the metric measures
    - `isDraft` boolean, required: A draft metric is hidden from Eng Intelligence
    - `key` string, required: Unique key that data points are recorded against
    - `name` string, required: Display name
    - `type` 'CQL' | 'PUBLIC_API', required: `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.
    - `valence` 'POSITIVE' | 'NEGATIVE' | 'NEUTRAL', required: Whether a higher value is better
  - `page` integer, required: Current page number, 0-indexed
  - `total` integer, required: Total number of results
  - `totalPages` integer, required: Total number of pages

## Other responses

- `429`: The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

## Changes

- **2026-11-03** `a7b058663c95`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/cortex/apis/cortex-api/changes/api/v1/eng-intel/custom-metrics/get.md)

---

[API](https://skmtc.dev/cortex/apis/cortex-api.md) - [All operations](https://skmtc.dev/cortex/apis/cortex-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cortex/apis/cortex-api/revisions/a7b058663c95?raw)