Pipelines
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:
```http
https://api.streamkap.com/pipelines/67bca128e1519efb914e6b51/metrics?time_interval=2&time_unit=hour×tamp_from=2025-03-02T07:10:15Z×tamp_to=2025-03-04T07:10:15Z
```
### Example Response:
```json
{
"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"
}
}
}
```
get/pipelines/{pipeline_id}/metrics
Request
- Base URLhttps://api.streamkap.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
pipeline_idstring required
Query parameters
time_intervalinteger
The interval between each metrics data point.
Example:1
time_unit'minute' | 'hour' | 'day' | 'week' | 'month'
The unit of the time interval. Combined with time_interval to determine the interval between each metrics data point. For example, if time_interval=1 and time_unit=hour, the interval between each metrics data point is 1 hour.
Example:hour
timestamp_fromstring date-time nullable
Start time of the metrics data in UTC timezone. If not provided, start time is set to 24 hours before the current time.
Example:2025-03-02T07:10:15Z
timestamp_tostring date-time nullable
End time of the metrics data in UTC timezone. If not provided, end time is set to the current time.
Example:2025-03-04T07:10:15Z
Response
Successful Response
Changes
No recorded changes to this operation across all 10 revisions of this API.