MetricListResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/prereason-com/json-schema/prereason-com-metric-list-response-schema.json",
  "title": "MetricListResponse",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/prereason-com-openapi.json#/components/schemas/MetricListResponse",
  "type": "object",
  "properties": {
    "count": {
      "type": "integer"
    },
    "metrics": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/MetricListItem"
      }
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "free_key": {
      "type": "string",
      "description": "What each tier reads of a metric, in one sentence"
    },
    "pro_only_metrics": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The metrics only pro briefings use, read from the live briefings. A basic key reads their latest reading alone."
    },
    "generated_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "$defs": {
    "MetricListItem": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "display_name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "category": {
          "type": "string",
          "enum": [
            "bitcoin",
            "calculated",
            "eth",
            "macro"
          ]
        },
        "instrument": {
          "type": "string",
          "enum": [
            "futures",
            "swap",
            "options"
          ],
          "description": "Present on a series that measures a futures, swap or options market (`futures`, `swap` or `options`), including a series PreReason calculates from one, and absent for every other series."
        }
      }
    }
  }
}