---
title: "Create a metric definition"
method: POST
path: "/api/metrics/definitions"
tags: ["Metrics"]
---

# Create a metric definition

`POST /api/metrics/definitions`

## Request body

- object
  - `slug` string
  - `title` string, required
  - `description` string, nullable
  - `definition` MetricDefinition, required
    - `version` 1, required
    - `widgets` MetricWidget[], required
      - `id` string, required
      - `title` string, required
      - `description` string
      - `query` object, required
        - `sql` string, required
        - `params` union[]
          - union
            - string
            - number
            - boolean
        - `maxRows` integer
      - `viz` MetricVizConfig, required
        - `type` 'stat' | 'table' | 'bar' | 'line' | 'multi-bar' | 'multi-line', required
        - `x` string
        - `y` string
        - `series` string[]
        - `label` string
        - `value` string
        - `columns` object[]
          - `key` string, required
          - `label` string
          - `format` 'number' | 'integer' | 'currency' | 'percent' | 'duration'
        - `format` 'number' | 'integer' | 'currency' | 'percent' | 'duration'
      - `colSpan` integer
      - `rowSpan` integer
    - `variables` MetricVariable[]
      - `key` string, required
      - `label` string
      - `type` 'text' | 'number' | 'select'
      - `defaultValue` union
        - string
        - number
        - boolean
      - `options` object[]
        - `label` string, required
        - `value` union, required
          - string
          - number
          - boolean
      - `optionsQuery` object
        - `sql` string, required
        - `valueKey` string, required
        - `labelKey` string
    - `layout` object
      - `columns` integer
    - `refreshSeconds` integer

## Response `201`

Metric created

- object
  - `id` string, required
  - `version` integer, required

## Other responses

- `400` — Invalid metric definition
- `409` — Slug already exists for this agent

---

[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)