v5

latestOpenAPI 3.0.3raw.githubusercontent.com2025-11-283726.4 KB
metrics

Get metric statistics over time

Retrieves metric values over a specified time range with a given interval

get/monitoring/metrics/{metric}/stats

Path parameters

metric'connections' | 'totalConnections' | 'numberOfSubscriptions' | 'sentMessages' | 'sentBytes' | 'receivedMessages' | 'receivedBytes' | 'slowConsumers' | 'memory' | 'storage' | 'accounts' | 'haAssets' | 'apiTotal' | 'apiErrors' | 'apiInflight' | 'streams' | 'consumers' | 'totalMessages' | 'totalBytes' | 'numberOfSubjects' | 'numberOfDeleted' | 'lostMessages' | 'lostBytes' | 'numberOfAckPending' | 'numberOfRedelivered' | 'numberOfWaiting' | 'numberOfPending' | 'pushBound' | 'paused' | 'deliveredConsumerSequence' | 'deliveredStreamSequence' | 'deliveredLastActive' | 'ackFloorConsumerSequence' | 'ackFloorStreamSequence' | 'ackFloorLastActive' | 'ram' | 'cpu' | 'slowConsumersClients' | 'slowConsumersRoutes' | 'slowConsumersGateways' | 'slowConsumersMeshs' | 'sentMessagesRate' | 'sentBytesRate' | 'receivedMessagesRate' | 'receivedBytesRate' required

Name of the metric to retrieve

Query parameters

fromstring date-time required

Start timestamp (ISO format)

tostring date-time required

End timestamp (ISO format)

intervalinteger

Aggregation interval in milliseconds

nodestring

Node identifier

accountstring

Account identifier (required if node not provided)

streamstring

Stream name

consumerstring

Consumer name (requires stream to be specified)

Response

Successful operation

messagestring

Response message

metadataobject

Optional metadata

All 3 operations