PRprereason
Metrics

List all metrics

Changed on

Returns every available metric with its name, description and category. Use this to discover what individual metrics are available.

get/api/metrics

Request

  • Base URL
    https://api.prereason.com
  • Auth
    none required

Query parameters

category'bitcoin' | 'calculated' | 'eth' | 'macro'

Filter by category

searchstring

Search by name or description

Response

List of available metrics

countinteger
categoriesstring[]
free_keystring

What each tier reads of a metric, in one sentence

pro_only_metricsstring[]

The metrics only pro briefings use, read from the live briefings. A basic key reads their latest reading alone.

generated_atstring date-time

Example response

{
  "count": 26,
  "metrics": [
    {
      "name": "bitcoin-price",
      "display_name": "Bitcoin Price",
      "description": "Current BTC price in USD",
      "category": "bitcoin"
    }
  ],
  "categories": [
    "bitcoin",
    "macro",
    "calculated",
    "treasury"
  ],
  "pro_only_metrics": [
    "oil-brent",
    "treasury-3mo"
  ]
}

Changes

  • 7d724ae5ac5eRevision changes
    • info

      added the optional property // to the response with the status

  • 5589dc1b96b1Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status