STstreamkap
Destinations

Get destination metrics (POST)

POST alternative for GET /destinations/metrics. Use when URL length limits are exceeded (e.g., 100+ IDs). Supports both query parameters and request body. Body parameters take precedence over query parameters.

post/destinations/metrics

Request

Query parameters

idstring nullable

Entity identifier to fetch metrics for

topic_list_frominteger nullable

Starting index for topic list pagination

topic_list_sizeinteger nullable

Number of topics to return in the list

string
OR
integer
sizeinteger nullable

Number of results to return

levelstring nullable

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

integer
OR
string
timestamp_tostring nullable

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

timestamp_fromstring nullable

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')

integer
OR
string
time_typestring nullable

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

tenant_idsstring nullable

A comma-separated list of Tenant IDs

idsstring nullable

A comma-separated list of destination IDs

snapshotstring nullable

Snapshot status filter

sortstring nullable

Field to sort results by

sort_dir'asc' | 'desc' nullable

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

Changes

No recorded changes to this operation across all 9 revisions of this API.