Get monitoring statistics
GET/statistics
Returns document processing and agent execution statistics for a time interval, aggregated from the Prometheus metrics of the API server and the workers, and the number of documents in the processing queue. A statistic whose Prometheus query fails is null, so that a failure is not read as no activity. A statistic for which Prometheus holds no data in the interval is 0. Each Prometheus query has a time limit of 10 seconds.
Permissions. An admin API key: a key with read, write and execute permission on every object type that permissions apply to and the allow-list * on pipelines, such as the master key. The statistics cover every pipeline and agent of the deployment. The admin field of the POST /login response shows whether a key is an admin API key.
Request
Responses
- 200
- 400
- 401
- 403
- 500
- 503
The body holds the statistics for the interval.
The interval value is not a valid Prometheus duration (Invalid interval format: <value>. Must be a valid Prometheus duration (e.g., 15m, 1h, 24h).). A request without interval also receives HTTP 400.
The authentication headers are missing or invalid, or the API key is inactive or expired. Errors lists the messages.
The calling key is not an admin API key (Forbidden: an admin API key is required).
The API server could not read the processing queue from NATS JetStream (Failed to get message queue information).
Every Prometheus query failed (Prometheus could not be queried; see the server logs), or the API server could not check the key (Unable to validate the API key; try again later).