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:

{
    "data": {
        "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,
    },
    "metadata": {
        "connector_status": {
            "name": "Destination State",
            "unit": "enum"
        },
        "latency": {
            "name": "Destination Latency",
            "unit": "milliseconds"
        },
        "sinkRecordReadTotal": {
            "name": "Events (Received)",
            "unit": "count"
        },
        "sinkRecordSendTotal": {
            "name": "Events (Sent)",
            "unit": "count"
        },
        "partitionCount": {
            "name": "Partition Count",
            "unit": "count"
        },
        "putBatchMaxTimeMs": {
            "name": "Put Batch Max Time",
            "unit": "milliseconds"
        },
        "bytesConsumedTotal": {
            "name": "Volume",
            "unit": "bytes"
        },
        "recordsConsumedTotal": {
            "name": "Consumed Events",
            "unit": "count"
        },
        "recordsLag": {
            "name": "Lag in Events",
            "unit": "count"
        }
    }
}

GET /destinations/{destination_id}/metrics

Get Metrics For Destination

cURL

curl --request GET \
  --url https://api.streamkap.com/destinations/{destination_id}/metrics \
  --header 'Authorization: Bearer <token>'

200

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

Authorizations

Authorization · string · header · required

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

Path Parameters

destination_id · string · required

Query Parameters

time_type · enum<string> · default: latest

Type of the metrics.

Available options: timeseries, timesummary, latest

Example:

"latest"

time_interval · integer · default: 1

The interval between each metrics data point.

Example:

1

time_unit · enum<string> · default: hour

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.

Available options: minute, hour, day, week, month

Example:

"hour"

timestamp_from · string<date-time> | null

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

Example:

"2025-03-02T07:10:15Z"

timestamp_to · string<date-time> | null

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

Example:

"2025-03-04T07:10:15Z"

Response

200

application/json

Successful Response

DestinationTimeseriesMetricsWithMetadata

DestinationLatestMetricsWithMetadata

DestinationTimesummaryMetricsWithMetadata

Destination timeseries metrics with metadata.

data · DestinationTimeseriesMetrics · object · required

Destination timeseries metrics.

Show child attributes

metadata · Metadata · object · required

Show child attributes