Skip to main content

Get Pipeline Metrics

Required role: read or higher.

Retrieve the metrics of a pipeline.

Path Parameters
pipeline_name string — REQUIRED

Unique pipeline name

Query Parameters
format string

Possible values: [prometheus, json]

Circuit metrics output format.

  • prometheus: format expected by Prometheus
  • json: JSON format
Responses
200

Pipeline circuit metrics retrieved successfully

Schema — OPTIONAL
string
404

Pipeline with that name does not exist

Schema — OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

500
Schema — OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.