Build

Metric Definitions

List the metric definitions available on a deal, with the metric_id and value_type needed to record a fact, in the Lev API.

Updated September 2026

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

List the metric definitions that can be recorded on a deal

Returns the catalog of metrics you can record on a deal — the metric_id and value_type you need when calling Insert Index Facts. Use it to discover what's recordable (for example NOI, occupancy, or purchase price) before writing a new fact. To change a fact a deal already has, prefer Search Index to find it, then Update Index Fact.

The catalog is shared across deals, not deal-specific — every deal sees the same definitions. Results are paginated and default to 100 per page.

Path parameters

deal_idintegerrequired

The deal ID

Query parameters

metric_labelstring

Case-insensitive search term to filter by metric label (for example, noi).

category_idinteger

Filter to a single metric category id (greater than 0).

pageinteger

1-based page number. Defaults to 1.

limitinteger

Metric definitions per page. Defaults to 100 and is clamped to 1-200.

curl "https://api.lev.com/api/external/v2/deals/101/index/metric-definitions?limit=100" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response (200):

{
  "request_id": "f6a7b8c9-d0e1-2345-fabc-456789012345",
  "timestamp": "2026-06-01T15:13:07Z",
  "data": [
    {
      "id": 136,
      "metric_key": "properties.property_financials.income.in_place_noi",
      "metric_label": "In-Place NOI",
      "value_type": "currency",
      "category_id": 38
    }
  ],
  "pagination": {
    "total": 458,
    "limit": 100,
    "offset": 0,
    "has_more": true
  }
}

422validation_error

limit must be an integer— A query parameter (page or limit) is non-numeric or out of range

401unauthorized

Authentication required— Missing or invalid Authorization header

404not_found

Deal not found— The deal_id doesn't exist or isn't accessible to the authenticated user

503service_unavailable

Deal metric definitions are temporarily unavailable. Please try again shortly.— The metric-definition service is unavailable