Skip to main content
GET
/
platform
/
pipeline-api
/
{pipeline_id}
/
metrics
Get pipeline metrics
curl --request GET \
  --url https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/metrics/ \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "uid": "covalent-postgres-pipe-3e8678c5fc9e48a7bf9879ca729",
    "records_consumed": 123,
    "last_offset": 123,
    "last_block_height": 123,
    "pending_records": 123,
    "processing_delay_ms": 123,
    "records_per_second": 123,
    "normalization_errors": 123
  },
  "error": true,
  "error_message": "<string>",
  "error_code": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://goldrush.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

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.
FieldWhat it means
records_consumedSource records read since the worker started.
last_offsetLast source offset committed by the worker.
last_block_heightMost recent block height processed.
pending_recordsRecords buffered but not yet written to the destination.
processing_delay_msEnd-to-end processing delay, source to destination.
records_per_secondRolling throughput.
normalization_errorsRecords dropped due to normalization or decoding errors. Compare against logs to investigate.

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