---
title: "List Deal Index Metric Definitions"
method: GET
path: "/api/external/v2/deals/{deal_id}/index/metric-definitions"
tags: ["external-v2-deals"]
---

# List Deal Index Metric Definitions

`GET /api/external/v2/deals/{deal_id}/index/metric-definitions`

## Request

- Base URL: `https://api.lev.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.lev.com/api/external/v2/deals/{deal_id}/index/metric-definitions`
- Auth: none declared

Return a basic metric catalog for deal-index insert/update clients.

## Path parameters

- `deal_id` integer, required

## Query parameters

- `metric_label` string, nullable: Optional case-insensitive metric label search term.
- `category_id` integer, nullable: Optional metric category id filter.
- `page` integer: 1-based page number.
- `limit` integer: Max metric definitions per page (1-200, clamped).

## Response `200`

Successful Response

- DealIndexMetricDefinitionListResponse: OpenAPI schema for GET /api/external/v2/deals/<id>/index/metric-definitions.
  - `request_id` string, required
  - `timestamp` string, required
  - `data` DealIndexMetricDefinitionResponse[], required
    - `id` integer, nullable
    - `metric_key` string, nullable
    - `metric_label` string, nullable
    - `value_type` string, nullable
    - `category_id` integer, nullable
    - `is_temporal` boolean, nullable
    - `formatting_rules` string, nullable
    - `support_multiple_values` boolean, nullable
    - `entity_type` string, nullable
    - `editable_form` string, nullable
    - `exclude_from_extraction` boolean, nullable
  - `pagination` unknown, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-08-14** `8490e8546c0a`: 1 info
  - added the optional property `data/items/exclude_from_extraction` to the response with the `200` status

[Operation history](https://skmtc.dev/lev/apis/lev-api/changes/api/external/v2/deals/:deal_id/index/metric-definitions/get.md)

---

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