GET
/
destinations
/
{destination_id}
/
metrics
Get Metrics For Destination
curl --request GET \
  --url https://api.streamkap.com/destinations/{destination_id}/metrics \
  --header 'Authorization: Bearer <token>'
{
  "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
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

Destination timeseries metrics with metadata.