---
title: "List metric definitions"
method: GET
path: "/api/metrics/definitions"
tags: ["Metrics"]
---

# List metric definitions

`GET /api/metrics/definitions`

## Query parameters

- `agentId` string
- `limit` integer
- `offset` integer, nullable
- `fields` 'full' | 'slim'

## Response `200`

Metric definitions

- object
  - `metrics` union[], required
    - union
      - Metric
        - `id` string, required
        - `agentId` string, required
        - `slug` string, required
        - `title` string, required
        - `description` string
        - `definition` MetricDefinition, required
          - `version` 1, required
          - `widgets` MetricWidget[], required
            - `id` string, required
            - `title` string, required
            - `description` string
            - `query` object, required
              - …
            - `viz` MetricVizConfig, required
              - …
            - `colSpan` integer
            - `rowSpan` integer
          - `variables` MetricVariable[]
            - `key` string, required
            - `label` string
            - `type` 'text' | 'number' | 'select'
            - `defaultValue` union
              - …
            - `options` object[]
              - …
            - `optionsQuery` object
              - …
          - `layout` object
            - `columns` integer
          - `refreshSeconds` integer
        - `createdAt` string, required
        - `updatedAt` string, required
      - object
        - `id` string, required
        - `agentId` string, required
        - `slug` string, required
        - `title` string, required
        - `description` string
        - `createdAt` string, required
        - `updatedAt` string, required
  - `total` number, required
  - `limit` number, required
  - `offset` number, required

---

[API](https://skmtc.net/desplega-ai/apis/agent-swarm-api.md) · [All operations](https://skmtc.net/desplega-ai/apis/agent-swarm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/desplega-ai/agent-swarm-api/versions/ef761849166b/schema)