Skip to main content
GET
/
pipelines
/
metrics
Get Metrics For Pipelines
curl --request GET \
  --url https://api.streamkap.com/pipelines/metrics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "<string>"
  ],
  "tenant_ids": [
    "<string>"
  ]
}
'
{
  "account_metrics": {},
  "connector_metrics": {},
  "inline_metrics": {},
  "task_metrics": {},
  "topic_metrics": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
string | null
​
topic_list_from
integer | null
​
topic_list_size
integer | null
​
from
​
size
integer | null
​
level
string | null
​
page
​
timestamp_to
​
timestamp_from
​
time_unit
string | null
​
time_interval
​
time_type
string | null
​
tenant_ids
string | null

A comma-separated list of Tenant IDs

​
ids
string | null

A comma-separated list of pipeline IDs

​
snapshot
string | null
​
sort
string | null
​
sort_dir
enum<string> | null
Available options:
asc,
desc

Body

application/json

Body model for POST /pipelines/metrics requests.

Supports large lists of IDs that would exceed URL length limits when using GET. Body parameters take precedence over query parameters when both are provided.

​
ids

List of pipeline IDs (as array) or comma-separated string. Body takes precedence over query params.

​
tenant_ids

List of tenant IDs (as array) or comma-separated string. Body takes precedence over query params.

Response

Successful Response

Pipeline metrics response.

​
account_metrics
Account Metrics · object
​
connector_metrics
Connector Metrics · object
​
inline_metrics
Inline Metrics · object
​
task_metrics
Task Metrics · object
​
topic_metrics
Topic Metrics · object