Internal site. Jolli authentication required to view.
Skip to Content
API ReferenceMetrics & DebuggingGET /v0/pipelines/{pipeline_name}/stats

Get Pipeline Stats

GET/v0/pipelines/{pipeline_name}/statsMetrics & Debugging

Try it

GET/v0/pipelines/{pipeline_name}/stats
Authentication
Parameters

Retrieve statistics (e.g., performance counters) of a running or paused pipeline.

Authentication

  • JSON web token (JWT) or API keyBearer token

Parameters

Path parameters

NameTypeRequiredDescription
pipeline_namestringYesUnique pipeline name

Response

200Pipeline statistics retrieved successfullyapplication/json
  • object
    Complete pipeline statistics returned by the `/stats` endpoint. This schema definition matches the serialized JSON structure from `adapters::controller::ControllerStatus`. The actual implementation with atomics and mutexes lives in the adapters crate, which uses ExternalControllerStatus to register this OpenAPI schema, making it available to pipeline-manager without requiring a direct dependency on the adapters crate.
    • checkpoint_activityobject
    • global_metricsobjectrequired
      Global controller metrics.
    • inputsInputEndpointStatus[]required
      Input endpoint configs and metrics.
    • outputsOutputEndpointStatus[]required
      Output endpoint configs and metrics.
    • permanent_checkpoint_errorsPermanentSuspendError[]
      If the pipeline fundamentally cannot checkpoint (e.g. storage is not configured, or an input endpoint does not support suspend), the reasons are listed here. Unlike a checkpoint failure, this means *no* checkpoint can succeed until the pipeline configuration changes.
    • suspend_errorobject
404Pipeline with that name does not existapplication/json
  • object
    Information returned by REST API endpoints on error.
    • detailsobjectrequired
      Detailed error metadata. The contents of this field is determined by `error_code`.
    • error_codestringrequired
      Error code is a string that specifies this error type.
    • messagestringrequired
      Human-readable error message.
500application/json
  • object
    Information returned by REST API endpoints on error.
    • detailsobjectrequired
      Detailed error metadata. The contents of this field is determined by `error_code`.
    • error_codestringrequired
      Error code is a string that specifies this error type.
    • messagestringrequired
      Human-readable error message.
503application/json
  • object
    Information returned by REST API endpoints on error.
    • detailsobjectrequired
      Detailed error metadata. The contents of this field is determined by `error_code`.
    • error_codestringrequired
      Error code is a string that specifies this error type.
    • messagestringrequired
      Human-readable error message.
Request
curl -X GET 'https://api.example.com/v0/pipelines/{pipeline_name}/stats' \ -H 'Authorization: Bearer YOUR_TOKEN'
Response
{ "message": "Unknown pipeline name 'non-existent-pipeline'", "error_code": "UnknownPipelineName", "details": { "pipeline_name": "non-existent-pipeline" } }