Skip to main content
GET
/
api
/
metrics
Metrics
curl --request GET \
  --url https://api.compose.market/api/metrics

Documentation Index

Fetch the complete documentation index at: https://docs.compose.market/llms.txt

Use this file to discover all available pages before exploring further.

Metrics routes are JSON by default. /api/metrics/events is a Server-Sent Events stream.

Routes

MethodPathAuthDescription
GET/api/metricsNoneReturns the current metrics snapshot.
GET/api/metrics/healthNoneReturns metrics service health.
GET/api/metrics/downloadsNoneRefreshes or returns download metrics.
POST/api/metrics/reindexInternalRuns an on-chain metrics backfill.
GET/api/metrics/eventsNoneStreams metrics snapshots and updates over SSE.

Query parameters

refresh
boolean
On /api/metrics and /api/metrics/downloads, set to true or 1 to force a refresh.
maxRanges
number
On /api/metrics/reindex, limits how many backfill ranges to process.

Headers

x-internal-secret
string
Required for POST /api/metrics/reindex.

SSE events

EventDescription
metrics.snapshotCurrent metrics payload.
metrics.changedUpdate notification from Redis pub/sub.
metrics.heartbeatHeartbeat every 25 seconds.