Skip to main content
GET
Get pipeline metrics
Requires a ServiceKey. See Service Keys.
Returns a snapshot of throughput and lag indicators at the moment of the request. There are no time-range query parameters - call repeatedly to build a time series client-side.

Authorizations

Authorization
string
header
required

Pipeline REST endpoints require a ServiceKey. Regular GoldRush API keys are rejected with 403. See Service Keys.

Path Parameters

pipeline_id
string
required

The pipeline identifier, prefixed with pipe_.

Response

Pipeline metrics snapshot.

data
object

Point-in-time pipeline metrics.

error
boolean
error_message
string | null
error_code
string | null