Get pipeline metrics

Point-in-time throughput and lag metrics for a pipeline.

GET /platform/pipeline-api/{pipeline_id}/metrics/

Get pipeline metrics

cURL

curl --request GET \
  --url https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/metrics/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/metrics/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/metrics/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/metrics/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/metrics/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/metrics/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/metrics/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "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>"
}

{
  "data": {},
  "error": true,
  "error_message": "<string>",
  "error_code": "<string>"
}

{
  "data": {},
  "error": true,
  "error_message": "<string>",
  "error_code": "<string>"
}

{
  "data": {},
  "error": true,
  "error_message": "<string>",
  "error_code": "<string>"
}

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.

Field	What it means
records_consumed	Source records read since the worker started.
last_offset	Last source offset committed by the worker.
last_block_height	Most recent block height processed.
pending_records	Records buffered but not yet written to the destination.
processing_delay_ms	End-to-end processing delay, source to destination.
records_per_second	Rolling throughput.
normalization_errors	Records 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

200

application/json

Pipeline metrics snapshot.

data · object

Point-in-time pipeline metrics.

Show child attributes

error · boolean

error_message · string | null

error_code · string | null