Skip to main content
POST
/
pipelines
/
metrics
Get pipeline metrics (POST)
curl --request POST \
  --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

Entity identifier to fetch metrics for

​
topic_list_from
integer | null

Starting index for topic list pagination

​
topic_list_size
integer | null

Number of topics to return in the list

​
from

Starting key for cursor-based pagination

​
size
integer | null

Number of results to return

​
level
string | null

Metrics aggregation level (e.g., 'connector', 'task', 'topic')

​
page

Page number for pagination

​
timestamp_to

End timestamp for metrics range (ISO 8601, e.g., '2025-01-15T10:00:00Z')

​
timestamp_from

Start timestamp for metrics range (ISO 8601, e.g., '2025-01-15T09:00:00Z')

​
time_unit
string | null

Time unit for aggregation (e.g., 'minute', 'hour', 'day')

​
time_interval

Time interval value for aggregation

​
time_type
string | null

Type of time-based query: 'timeseries', 'latest', or 'timesummary'

​
tenant_ids
string | null

A comma-separated list of Tenant IDs

​
ids
string | null

A comma-separated list of pipeline IDs

​
snapshot
string | null

Snapshot status filter

​
sort
string | null

Field to sort results by

​
sort_dir
enum<string> | null

Sort direction: 'asc' or 'desc'

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