Sign in

v1

OpenAPI 3.1.0Proprietary2026-07-13197242444.9 KB
Pipelines

Get Metrics For Pipelines

get/pipelines/metrics

Query parameters

idstring nullable

Entity identifier to fetch metrics for

Entity identifier to fetch metrics for

topic_list_frominteger nullable

Starting index for topic list pagination

Starting index for topic list pagination

topic_list_sizeinteger nullable

Number of topics to return in the list

Number of topics to return in the list

string
OR
integer

Starting key for cursor-based pagination

sizeinteger nullable

Number of results to return

Number of results to return

levelstring nullable

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

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

integer
OR
string

Page number for pagination

string
OR
string date-time

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

string
OR
string date-time

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

time_unitstring nullable

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

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

integer
OR
string

Time interval value for aggregation

time_typestring nullable

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

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

tenant_idsstring nullable

A comma-separated list of Tenant IDs

A comma-separated list of Tenant IDs

idsstring nullable

A comma-separated list of pipeline IDs

A comma-separated list of pipeline IDs

snapshotstring nullable

Snapshot status filter

Snapshot status filter

sortstring nullable

Field to sort results by

Field to sort results by

sort_dir'asc' | 'desc' nullable

Sort direction: 'asc' or 'desc'

Sort direction: 'asc' or 'desc'

Request body

Response

Successful Response

account_metricsobject nullable
connector_metricsobject nullable
inline_metricsobject nullable
task_metricsobject nullable
topic_metricsobject nullable