Get Metrics For Pipeline

Retrieve metrics for a specific pipeline based on the provided parameters.

This endpoint returns latest metrics data for a given pipeline ID

• timesummary and timeseries will be supported soon, the time interval, and the time range. The response includes metadata about the metrics and is tailored to the specified time type.

Parameters:

• pipeline_id (path): The unique identifier of the pipeline for which metrics are requested.
• time_interval (query): The numeric interval between metrics data points (e.g., 1, 2, etc.).
• time_unit (query): The unit of time for the interval (e.g., minute, hour, day, week, month). Combined with time_interval to define the granularity (e.g., 1 hour, 2 days).
• timestamp_from (query, optional): The start time of the metrics data in UTC (ISO 8601 format, e.g., 2025-03-02T07:10:15Z). Defaults to 24 hours before the current time if not provided.
• timestamp_to (query, optional): The end time of the metrics data in UTC (ISO 8601 format). Defaults to the current time if not provided.

Authentication:

• Requires a valid user token with the read:pipeline_metrics permission.

Returns:

• PipelineLatestMetricsWithMetadata: latest metrics.

Errors:

• 400 Bad Request: Invalid parameters or unexpected errors during processing.
• 404 Not Found: Metrics not found for the specified pipeline or connector plugin issues.
• 500 Internal Server Error: Connector plugin not found or misconfigured.

Example Request:

https://api.streamkap.com/pipelines/67bca128e1519efb914e6b51/metrics?time_interval=2&time_unit=hour&timestamp_from=2025-03-02T07:10:15Z&timestamp_to=2025-03-04T07:10:15Z

Example Response:

{
    "data": {
        "latency": 1,
        "recordsLag": 0,
        "status": "Active"
    },
    "metadata": {
        "latency": {
            "name": "Pipeline Latency",
            "unit": "milliseconds"
        },
        "status": {
            "name": "Pipeline Status",
            "unit": "milliseconds"
        },
        "recordsLag": {
            "name": "Lag in Events",
            "unit": "count"
        }
    }
}

curl -X GET "https://api.streamkap.com/pipelines/string/metrics" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.streamkap.com/pipelines/string/metrics", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.streamkap.com/pipelines/string/metrics",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

{
  "data": {
    "latency": 0,
    "recordsLag": 0,
    "status": "string"
  },
  "metadata": {
    "property1": {
      "property1": "string",
      "property2": "string"
    },
    "property2": {
      "property1": "string",
      "property2": "string"
    }
  }
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}