Get Metrics For Source

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

This endpoint returns metrics data for a given source 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:

• source_id (path): The unique identifier of the source 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:source_metrics permission.

Returns:

Depending on the time_type:

• SourceTimeseriesMetricsWithMetadata: For timeseries metrics.
• SourceTimesummaryMetricsWithMetadata: For timesummary metrics.
• SourceLatestMetricsWithMetadata: For latest metrics.

Errors:

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

Example Request:

https://api.streamkap.com/sources/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": {
        "SnapshotTotalNumberOfEventsSeen": 20254,
        "SnapshotMilliSecondsSinceLastEvent": 0,
        "StreamingMilliSecondsBehindSource": 0,
        "StreamingTotalNumberOfDeleteEventsSeen": 312,
        "StreamingTotalNumberOfUpdateEventsSeen": 0,
        "StreamingTotalNumberOfCreateEventsSeen": 73,
        "StreamingMilliSecondsSinceLastEvent": 0,
        "StreamingLastEvent": "position: {ord: 14}, key: {"id" : ""ceaafb88-2a60-4bd9-8515-719ba64ea05c-close""}",
        "recordRetryTotal": null,
        "byteTotal": 9018776,
        "sourceRecordWriteTotal": 28977,
        "SnapshotRunning": 0,
        "SnapshotCompleted": 0,
        "StreamingConnected": 1,
        "recordSendTotal": null,
        "state": "Streaming",
        "streamingState": "connected",
        "snapshotStatus": [
            {
                "status": "completed",
                "topic_id": "source_67a5c35e64af6fd83f4c17a6.Test.test_data1",
                "submit_timestamp": null
            },
            {
                "status": "completed",
                "topic_id": "source_67a5c35e64af6fd83f4c17a6.Test.test_data2",
                "submit_timestamp": null
            }
        ],
        "snapshotState": "completed",
        "recordWrittenTotal": null,
        "connector_status": "Active",
        "latency": 0
    },
    "metadata": {
        "state": {
            "name": "Enabled State",
            "unit": "enum"
        },
        "streamingState": {
            "name": "Streaming State",
            "unit": "enum"
        },
        "snapshotStatus": {
            "name": "Snapshot Status",
            "unit": "enum"
        },
        "snapshotState": {
            "name": "Snapshot State",
            "unit": "enum"
        },
        "connector_status": {
            "name": "Source State",
            "unit": "enum"
        },
        "latency": {
            "name": "Source Latency",
            "unit": "milliseconds"
        },
        "byteTotal": {
            "name": "Volume",
            "unit": "bytes"
        },
        "recordRetryTotal": {
            "name": "Retried",
            "unit": "count"
        },
        "recordSendTotal": {
            "name": "Received",
            "unit": "count"
        },
        "recordWrittenTotal": {
            "name": "Events Written",
            "unit": "count"
        },
        "SnapshotTotalNumberOfEventsSeen": {
            "name": "Events (Snapshot)",
            "unit": "count"
        },
        "SnapshotRunning": {
            "name": "Snapshot Running?",
            "unit": "boolean"
        },
        "SnapshotCompleted": {
            "name": "Snapshot Completed?",
            "unit": "boolean"
        },
        "SnapshotMilliSecondsSinceLastEvent": {
            "name": "Time Since Last Snapshot Event",
            "unit": "milliseconds"
        },
        "StreamingMilliSecondsBehindSource": {
            "name": "Latency Behind Source",
            "unit": "milliseconds"
        },
        "StreamingConnected": {
            "name": "Streaming Connected?",
            "unit": "boolean"
        },
        "StreamingTotalNumberOfDeleteEventsSeen": {
            "name": "Events (Delete)",
            "unit": "count"
        },
        "StreamingTotalNumberOfUpdateEventsSeen": {
            "name": "Events (Update)",
            "unit": "count"
        },
        "StreamingTotalNumberOfCreateEventsSeen": {
            "name": "Events (Create)",
            "unit": "count"
        },
        "StreamingMilliSecondsSinceLastEvent": {
            "name": "Time Since Last Streaming Event",
            "unit": "milliseconds"
        },
        "StreamingLastEvent": {
            "name": "Last Streaming Event",
            "unit": "id"
        },
        "sourceRecordWriteTotal": {
            "name": "Events Written",
            "unit": "count"
        }
    }
}