GET
/
sources
/
{source_id}
/
metrics
Get Metrics For Source
curl --request GET \
  --url https://api.streamkap.com/sources/{source_id}/metrics \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "SnapshotMilliSecondsSinceLastEvent": [
      {
        "timestamp": "2025-03-02 08:00:00",
        "value": 500
      },
      {
        "timestamp": "2025-03-02 09:00:00",
        "value": 300
      }
    ],
    "SnapshotTotalNumberOfEventsSeen": [
      {
        "timestamp": "2025-03-02 08:00:00",
        "value": 100
      },
      {
        "timestamp": "2025-03-02 09:00:00",
        "value": 150
      }
    ],
    "StreamingMilliSecondsBehindSource": [
      {
        "timestamp": "2025-03-02 08:00:00",
        "value": 1000
      },
      {
        "timestamp": "2025-03-02 09:00:00",
        "value": 800
      }
    ],
    "StreamingMilliSecondsSinceLastEvent": [
      {
        "timestamp": "2025-03-02 08:00:00",
        "value": 200
      },
      {
        "timestamp": "2025-03-02 09:00:00",
        "value": 150
      }
    ],
    "StreamingTotalNumberOfCreateEventsSeen": [
      {
        "timestamp": "2025-03-02 08:00:00",
        "value": 20
      },
      {
        "timestamp": "2025-03-02 09:00:00",
        "value": 35
      }
    ],
    "StreamingTotalNumberOfDeleteEventsSeen": [
      {
        "timestamp": "2025-03-02 08:00:00",
        "value": 5
      },
      {
        "timestamp": "2025-03-02 09:00:00",
        "value": 8
      }
    ],
    "StreamingTotalNumberOfUpdateEventsSeen": [
      {
        "timestamp": "2025-03-02 08:00:00",
        "value": 30
      },
      {
        "timestamp": "2025-03-02 09:00:00",
        "value": 45
      }
    ],
    "byteTotal": [
      {
        "timestamp": "2025-03-02 08:00:00",
        "value": 10000
      },
      {
        "timestamp": "2025-03-02 09:00:00",
        "value": 15000
      }
    ],
    "recordRetryTotal": [
      {
        "timestamp": "2025-03-02 08:00:00",
        "value": 2
      },
      {
        "timestamp": "2025-03-02 09:00:00",
        "value": 3
      }
    ],
    "recordSendTotal": [
      {
        "timestamp": "2025-03-02 08:00:00",
        "value": 50
      },
      {
        "timestamp": "2025-03-02 09:00:00",
        "value": 70
      }
    ],
    "recordWrittenTotal": [
      {
        "timestamp": "2025-03-02 08:00:00",
        "value": 40
      },
      {
        "timestamp": "2025-03-02 09:00:00",
        "value": 60
      }
    ],
    "sourceRecordWriteTotal": [
      {
        "timestamp": "2025-03-02 08:00:00",
        "value": 25
      },
      {
        "timestamp": "2025-03-02 09:00:00",
        "value": 40
      }
    ]
  },
  "metadata": {}
}

Authorizations

Authorization
string
header
required

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

Path Parameters

source_id
string
required

Query Parameters

time_type
enum<string>
default:latest

Type of the metrics.

Available options:
timeseries,
timesummary,
latest
time_interval
integer
default:1

The interval between each metrics data point.

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
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.

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.

Response

Successful Response

data
object
required

Source timeseries metrics.

Example:
{
"SnapshotMilliSecondsSinceLastEvent": [
{
"timestamp": "2025-03-02 08:00:00",
"value": 500
},
{
"timestamp": "2025-03-02 09:00:00",
"value": 300
}
],
"SnapshotTotalNumberOfEventsSeen": [
{
"timestamp": "2025-03-02 08:00:00",
"value": 100
},
{
"timestamp": "2025-03-02 09:00:00",
"value": 150
}
],
"StreamingMilliSecondsBehindSource": [
{
"timestamp": "2025-03-02 08:00:00",
"value": 1000
},
{
"timestamp": "2025-03-02 09:00:00",
"value": 800
}
],
"StreamingMilliSecondsSinceLastEvent": [
{
"timestamp": "2025-03-02 08:00:00",
"value": 200
},
{
"timestamp": "2025-03-02 09:00:00",
"value": 150
}
],
"StreamingTotalNumberOfCreateEventsSeen": [
{
"timestamp": "2025-03-02 08:00:00",
"value": 20
},
{
"timestamp": "2025-03-02 09:00:00",
"value": 35
}
],
"StreamingTotalNumberOfDeleteEventsSeen": [
{
"timestamp": "2025-03-02 08:00:00",
"value": 5
},
{
"timestamp": "2025-03-02 09:00:00",
"value": 8
}
],
"StreamingTotalNumberOfUpdateEventsSeen": [
{
"timestamp": "2025-03-02 08:00:00",
"value": 30
},
{
"timestamp": "2025-03-02 09:00:00",
"value": 45
}
],
"byteTotal": [
{
"timestamp": "2025-03-02 08:00:00",
"value": 10000
},
{
"timestamp": "2025-03-02 09:00:00",
"value": 15000
}
],
"recordRetryTotal": [
{
"timestamp": "2025-03-02 08:00:00",
"value": 2
},
{
"timestamp": "2025-03-02 09:00:00",
"value": 3
}
],
"recordSendTotal": [
{
"timestamp": "2025-03-02 08:00:00",
"value": 50
},
{
"timestamp": "2025-03-02 09:00:00",
"value": 70
}
],
"recordWrittenTotal": [
{
"timestamp": "2025-03-02 08:00:00",
"value": 40
},
{
"timestamp": "2025-03-02 09:00:00",
"value": 60
}
],
"sourceRecordWriteTotal": [
{
"timestamp": "2025-03-02 08:00:00",
"value": 25
},
{
"timestamp": "2025-03-02 09:00:00",
"value": 40
}
]
}
metadata
object
required