Get Metrics For Destination

Retrieve metrics for a specific destination based on the provided parameters.

This endpoint returns metrics data for a given destination ID, allowing flexibility in the type of metrics returned (timeseries, timesummary, or latest), the time interval, and the time range. The response includes metadata about the metrics and is tailored to the specified time type.

Parameters:

destination_id (path): The unique identifier of the destination for which metrics are requested.
time_type (query): Specifies the type of metrics to return:
- timeseries: Metrics over a series of time intervals.
- timesummary: Aggregated summary of metrics over the specified period.
- latest: The most recent metrics available.
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:destination_metrics permission.

Returns:

Depending on the time_type:

DestinationTimeseriesMetricsWithMetadata: For timeseries metrics.
DestinationTimesummaryMetricsWithMetadata: For timesummary metrics.
DestinationLatestMetricsWithMetadata: For latest metrics.

Errors:

400 Bad Request: Invalid parameters or unexpected errors during processing.
404 Not Found: Metrics not found for the specified destination or connector plugin issues.
500 Internal Server Error: Connector plugin not found or misconfigured.

Example Request:

https://api.streamkap.com/destinations/67ad6e0af08a2365c729ba79/metrics?time_type=latest&time_interval=2&time_unit=hour&timestamp_from=2025-03-02T07:10:15Z&timestamp_to=2025-03-04T07:10:15Z

Example Response:

&#123;
    "data": &#123;
        "connector_status": "Active",
        "latency": 0.0,
        "partitionCount": 1.0,
        "putBatchMaxTimeMs": 0.0,
        "recordsLag": 0.0,
        "sinkRecordReadTotal": 101.0,
        "recordsConsumedTotal": null,
        "sinkRecordSendTotal": 65.0,
        "bytesConsumedTotal": null,
    &#125;,
    "metadata": &#123;
        "connector_status": &#123;
            "name": "Destination State",
            "unit": "enum"
        &#125;,
        "latency": &#123;
            "name": "Destination Latency",
            "unit": "milliseconds"
        &#125;,
        "sinkRecordReadTotal": &#123;
            "name": "Events (Received)",
            "unit": "count"
        &#125;,
        "sinkRecordSendTotal": &#123;
            "name": "Events (Sent)",
            "unit": "count"
        &#125;,
        "partitionCount": &#123;
            "name": "Partition Count",
            "unit": "count"
        &#125;,
        "putBatchMaxTimeMs": &#123;
            "name": "Put Batch Max Time",
            "unit": "milliseconds"
        &#125;,
        "bytesConsumedTotal": &#123;
            "name": "Volume",
            "unit": "bytes"
        &#125;,
        "recordsConsumedTotal": &#123;
            "name": "Consumed Events",
            "unit": "count"
        &#125;,
        "recordsLag": &#123;
            "name": "Lag in Events",
            "unit": "count"
        &#125;
    &#125;
&#125;

GET/destinations/{destination_id}/metrics

Authorization

AuthorizationBearer token · headerrequired

Path parameters

destination_idstringrequired

Query parameters

time_typestring

Type of the metrics.

default: "latest"

Allowed:timeseriestimesummarylatest

time_intervalinteger

The interval between each metrics data point.

default: 1

time_unitstring

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.

default: "hour"

Allowed:minutehourdayweekmonth

timestamp_fromstring<date-time>

Start time of the metrics data in UTC timezone. If not provided, start time is set to 24 hours before the current time.

timestamp_tostring<date-time>

End time of the metrics data in UTC timezone. If not provided, end time is set to the current time.

Responses

200

Successful Response

Any of:

DestinationTimeseriesMetricsWithMetadata

dataDestinationTimeseriesMetricsrequired

Destination timeseries metrics.

Show properties

latencyTimeseriesEntry[] | null

default: []

Show properties

Any of:

TimeseriesEntry[]

Array of TimeseriesEntry

valueinteger | numberrequired

The metric value at this timestamp

Show properties

Any of:

integer

integer

number

number

timestampstringrequired

ISO 8601 timestamp for this data point

null

null

partitionCountTimeseriesEntry[]

default: []

Show properties

Array of TimeseriesEntry

valueinteger | numberrequired

The metric value at this timestamp

Show properties

Any of:

integer

integer

number

number

timestampstringrequired

ISO 8601 timestamp for this data point

putBatchMaxTimeMsTimeseriesEntry[]

default: []

Show properties

Array of TimeseriesEntry

valueinteger | numberrequired

The metric value at this timestamp

Show properties

Any of:

integer

integer

number

number

timestampstringrequired

ISO 8601 timestamp for this data point

recordsLagTimeseriesEntry[] | null

default: []

Show properties

Any of:

TimeseriesEntry[]

Array of TimeseriesEntry

valueinteger | numberrequired

The metric value at this timestamp

Show properties

Any of:

integer

integer

number

number

timestampstringrequired

ISO 8601 timestamp for this data point

null

null

sinkRecordReadTotalTimeseriesEntry[]

default: []

Show properties

Array of TimeseriesEntry

valueinteger | numberrequired

The metric value at this timestamp

Show properties

Any of:

integer

integer

number

number

timestampstringrequired

ISO 8601 timestamp for this data point

recordsConsumedTotalTimeseriesEntry[]

default: []

Show properties

Array of TimeseriesEntry

valueinteger | numberrequired

The metric value at this timestamp

Show properties

Any of:

integer

integer

number

number

timestampstringrequired

ISO 8601 timestamp for this data point

sinkRecordSendTotalTimeseriesEntry[] | null

default: []

Show properties

Any of:

TimeseriesEntry[]

Array of TimeseriesEntry

valueinteger | numberrequired

The metric value at this timestamp

Show properties

Any of:

integer

integer

number

number

timestampstringrequired

ISO 8601 timestamp for this data point

null

null

bytesConsumedTotalTimeseriesEntry[]

default: []

Show properties

Array of TimeseriesEntry

valueinteger | numberrequired

The metric value at this timestamp

Show properties

Any of:

integer

integer

number

number

timestampstringrequired

ISO 8601 timestamp for this data point

qa_exact_count_diffTimeseriesEntry[]

default: []

Show properties

Array of TimeseriesEntry

valueinteger | numberrequired

The metric value at this timestamp

Show properties

Any of:

integer

integer

number

number

timestampstringrequired

ISO 8601 timestamp for this data point

metadataobjectrequired

DestinationLatestMetricsWithMetadata

dataDestinationLatestMetricsrequired

Destination latest metrics.

Show properties

connector_statusstring | null

Show properties

Any of:

string

string

null

null

latencyinteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

partitionCountinteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

putBatchMaxTimeMsinteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

recordsLaginteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

sinkRecordReadTotalinteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

recordsConsumedTotalinteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

sinkRecordSendTotalinteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

bytesConsumedTotalinteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

qa_exact_count_diffinteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

metadataobjectrequired

DestinationTimesummaryMetricsWithMetadata

dataDestinationTimesummaryMetricsrequired

Destination timesummary metrics.

Show properties

connector_statusstring | null

Show properties

Any of:

string

string

null

null

latencyinteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

partitionCountinteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

putBatchMaxTimeMsinteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

recordsConsumedTotalinteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

recordsLaginteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

sinkRecordReadTotalinteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

sinkRecordSendTotalinteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

bytesConsumedTotalinteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

qa_exact_count_diffinteger | number | null

Show properties

Any of:

integer

integer

number

number

null

null

metadataobjectrequired

422

Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X GET 'https://api.streamkap.com/destinations/string/metrics' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.streamkap.com/destinations/string/metrics", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.streamkap.com/destinations/string/metrics",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "data": {
    "latency": [],
    "partitionCount": [],
    "putBatchMaxTimeMs": [],
    "recordsLag": [],
    "sinkRecordReadTotal": [],
    "recordsConsumedTotal": [],
    "sinkRecordSendTotal": [],
    "bytesConsumedTotal": [],
    "qa_exact_count_diff": []
  },
  "metadata": {
    "property1": {
      "property1": "string",
      "property2": "string"
    },
    "property2": {
      "property1": "string",
      "property2": "string"
    }
  }
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}