pub.chive.admin.getPrometheusMetrics Documentation (EN)

main query

Get Prometheus metrics as JSON

Output

Encodingapplication/json

metrics array Required

Prometheus metric entries

timestamp stringdatetime Required

Timestamp of the metrics snapshot

Errors

AuthenticationRequired

AdminRequired

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "AdminRequired"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "metrics",
        "timestamp"
      ],
      "properties": {
        "metrics": {
          "type": "array",
          "items": {
            "ref": "#prometheusMetric",
            "type": "ref"
          },
          "description": "Prometheus metric entries"
        },
        "timestamp": {
          "type": "string",
          "format": "datetime",
          "description": "Timestamp of the metrics snapshot"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {}
  },
  "description": "Get Prometheus metrics as JSON"
}

labelSet object

Key-value pairs for metric labels

This object has no properties defined.

View raw schema

{
  "type": "object",
  "properties": {},
  "description": "Key-value pairs for metric labels"
}

metricValue object

A single metric value with its label set

Properties

exemplar string Optional

Optional exemplar value (numeric string)

labels ref #labelSet Optional

Label key-value pairs

value string Required

Metric value (numeric string)

View raw schema

{
  "type": "object",
  "required": [
    "value"
  ],
  "properties": {
    "value": {
      "type": "string",
      "description": "Metric value (numeric string)"
    },
    "labels": {
      "ref": "#labelSet",
      "type": "ref",
      "description": "Label key-value pairs"
    },
    "exemplar": {
      "type": "string",
      "description": "Optional exemplar value (numeric string)"
    }
  },
  "description": "A single metric value with its label set"
}

prometheusMetric object

A single Prometheus metric with its values

Properties

help string Required

Metric help text

name string Required

Metric name

type string Required

Metric type

Known values: counter, gauge, histogram, summary

values array of ref#metricValue Required

Metric values with labels

View raw schema

{
  "type": "object",
  "required": [
    "name",
    "help",
    "type",
    "values"
  ],
  "properties": {
    "help": {
      "type": "string",
      "description": "Metric help text"
    },
    "name": {
      "type": "string",
      "description": "Metric name"
    },
    "type": {
      "type": "string",
      "description": "Metric type",
      "knownValues": [
        "counter",
        "gauge",
        "histogram",
        "summary"
      ]
    },
    "values": {
      "type": "array",
      "items": {
        "ref": "#metricValue",
        "type": "ref"
      },
      "description": "Metric values with labels"
    }
  },
  "description": "A single Prometheus metric with its values"
}