---
title: "List metrics"
method: GET
path: "/beta/intelligence/metrics"
tags: ["Intelligence"]
---

# List metrics

`GET /beta/intelligence/metrics`

## Request

- Base URL: `https://dev.dixa.io`
- URL: `https://dev.dixa.io/beta/intelligence/metrics`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/dixa/apis/dixa-api/docs/beta/intelligence/metrics/get.ts> (a function with typed inputs; its response is checked against the schema)

List the metrics you can query, with the filters and aggregates of each metric and the records it is based on. Use the metric `id` with Query conversation metric, Query agent metric or Query AI agent metric.

## Query parameters

- `category` 'conversations' | 'agents' | 'aiagents'
- `pageKey` string
- `pageLimit` integer

## Response `200`

The list of metrics

- IntelligenceMetricCatalogue
  - `data` MetricCatalogueEntry[]
    - `id` string, required: The metric id, used in the URL when you query the metric
    - `name` string, required: The display name
    - `category` string, required: `conversations`, `agents` or `aiagents`. Decides which endpoint you query the metric with
    - `description` string, required: A short description of the metric
    - `definition` string: How the metric is calculated, if documented
    - `deprecated` boolean, required: Whether the metric will be removed. A deprecated metric can still be queried
    - `primaryFilters` string[]: The keys the `primaryFilter` of a query supports: `period`, `conversationIds` or both
    - `filters` FilterDescriptor[]: The filters the metric supports
      - `attribute` string, required: The value to use as a filter's `attribute`
      - `aliases` string[]: Other names you can use for the attribute. Responses always use `attribute`
      - `type` 'String' | 'Integer' | 'Number' | 'Boolean' | 'Uuid' | 'Timestamp' | 'Entity' | 'List' | 'Object', required: The type of the filter values
      - `operators` string[]: The operators the attribute supports
      - `defaultOperator` 'IsEmpty' | 'IsNotEmpty' | 'IsOne' | 'IsNotOne' | 'IsAll' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual', required: The operator used when a filter has no `operator`
      - `description` string, required: A description of the filter
    - `aggregates` MetricAggregate[]: The values the metric returns
      - `name` string, required: The key of the value in the response
      - `type` 'String' | 'Integer' | 'Number' | 'Boolean' | 'Uuid' | 'Timestamp' | 'Entity' | 'List' | 'Object', required: The type of the value
      - `unit` string: The unit of the value, such as milliseconds. Not set when the value has no unit
      - `defaultIncluded` boolean, required: Whether the value is returned by default. All values are currently returned
      - `description` string, required: A description of the value
    - `relatedRecordIds` string[]: The records the metric is based on
  - `meta` PaginationLinks
    - `previous` string: url
    - `next` string: url

## Other responses

- `400`
- `404`: An entity in this request could not be found
- `500`: Internal failure during request processing

## Changes

- **2026-10-19** `2c1d0ef4a36d`: 1 info
  - added the new enum value `aiagents` to the `query` request parameter `category`
- **2026-10-19** `b492695788bb`: 8 info
  - removed the `Between` enum value from the `data/items/filters/items/defaultOperator` response property for the response status `200`
  - removed the `Between` enum value from the `data/items/filters/items/operators/items/` response property for the response status `200`
  - removed the `Equals` enum value from the `data/items/filters/items/defaultOperator` response property for the response status `200`
  - removed the `Equals` enum value from the `data/items/filters/items/operators/items/` response property for the response status `200`
  - …4 more
- **2026-10-14** `9e01458f1a5f`: 44 warning, 46 info
  - added the new `Between` enum value to the `data/items/filters/items/defaultOperator` response property for the response status `200`
  - added the new `Between` enum value to the `data/items/filters/items/operators/items/` response property for the response status `200`
  - added the new `Boolean` enum value to the `data/items/aggregates/items/type` response property for the response status `200`
  - added the new `Boolean` enum value to the `data/items/filters/items/type` response property for the response status `200`
  - …86 more
- **2026-09-23** `eab8fd8df708`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/dixa/apis/dixa-api/changes/beta/intelligence/metrics/get.md)

---

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