Skip to content
Streamkap
Esc
↑↓navigate↵open⌘Jpreview

Get Metrics For Pipelines

GET/pipelines/metrics
Authorization
AuthorizationBearer token · headerrequired
Query parameters
idstring

Entity identifier to fetch metrics for

topic_list_frominteger

Starting index for topic list pagination

topic_list_sizeinteger

Number of topics to return in the list

fromstring | integer

Starting key for cursor-based pagination

sizeinteger

Number of results to return

levelstring

Metrics aggregation level (e.g., 'connector', 'task', 'topic')

pageinteger | string

Page number for pagination

timestamp_tostring | string<date-time>

End timestamp for metrics range (ISO 8601, e.g., '2025-01-15T10:00:00Z')

timestamp_fromstring | string<date-time>

Start timestamp for metrics range (ISO 8601, e.g., '2025-01-15T09:00:00Z')

time_unitstring

Time unit for aggregation (e.g., 'minute', 'hour', 'day')

time_intervalinteger | string

Time interval value for aggregation

time_typestring

Type of time-based query: 'timeseries', 'latest', or 'timesummary'

tenant_idsstring

A comma-separated list of Tenant IDs

idsstring

A comma-separated list of pipeline IDs

snapshotstring

Snapshot status filter

sortstring

Field to sort results by

sort_dirstring

Sort direction: 'asc' or 'desc'

Request body
application/json
Any of:
PipelineMetricsReqBody
idsstring[] | string | null

List of pipeline IDs (as array) or comma-separated string. Body takes precedence over query params.

Show properties
Any of:
string[]
Array of string
string
string
string
null
null
tenant_idsstring[] | string | null

List of tenant IDs (as array) or comma-separated string. Body takes precedence over query params.

Show properties
Any of:
string[]
Array of string
string
string
string
null
null
null
null
Responses
200

Successful Response

account_metricsobject | null
Show properties
Any of:
object
object
null
null
connector_metricsobject | null
Show properties
Any of:
object
object
null
null
inline_metricsobject | null
Show properties
Any of:
object
object
null
null
task_metricsobject | null
Show properties
Any of:
object
object
null
null
topic_metricsobject | null
Show properties
Any of:
object
object
null
null
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/pipelines/metrics' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "ids": [
    "string"
  ],
  "tenant_ids": [
    "string"
  ]
}'
Response
{
  "account_metrics": {
    "property1": {
      "timeseries": {
        "latency": [],
        "recordsLag": [],
        "status": []
      },
      "latest": {
        "latency": 0,
        "recordsLag": 0,
        "status": "string"
      },
      "timesummary": {
        "latency": 0,
        "recordsLag": 0,
        "status": 0
      }
    },
    "property2": {
      "timeseries": {
        "latency": [],
        "recordsLag": [],
        "status": []
      },
      "latest": {
        "latency": 0,
        "recordsLag": 0,
        "status": "string"
      },
      "timesummary": {
        "latency": 0,
        "recordsLag": 0,
        "status": 0
      }
    }
  },
  "connector_metrics": {
    "property1": {
      "timeseries": {
        "latency": [],
        "recordsLag": [],
        "status": []
      },
      "latest": {
        "latency": 0,
        "recordsLag": 0,
        "status": "string"
      },
      "timesummary": {
        "latency": 0,
        "recordsLag": 0,
        "status": 0
      }
    },
    "property2": {
      "timeseries": {
        "latency": [],
        "recordsLag": [],
        "status": []
      },
      "latest": {
        "latency": 0,
        "recordsLag": 0,
        "status": "string"
      },
      "timesummary": {
        "latency": 0,
        "recordsLag": 0,
        "status": 0
      }
    }
  },
  "inline_metrics": {
    "property1": {
      "timeseries": {
        "latency": [],
        "recordsLag": [],
        "status": []
      },
      "latest": {
        "latency": 0,
        "recordsLag": 0,
        "status": "string"
      },
      "timesummary": {
        "latency": 0,
        "recordsLag": 0,
        "status": 0
      }
    },
    "property2": {
      "timeseries": {
        "latency": [],
        "recordsLag": [],
        "status": []
      },
      "latest": {
        "latency": 0,
        "recordsLag": 0,
        "status": "string"
      },
      "timesummary": {
        "latency": 0,
        "recordsLag": 0,
        "status": 0
      }
    }
  },
  "task_metrics": {
    "property1": {
      "property1": {
        "timeseries": {
          "latency": [],
          "recordsLag": [],
          "status": []
        },
        "latest": {
          "latency": 0,
          "recordsLag": 0,
          "status": "string"
        },
        "timesummary": {
          "latency": 0,
          "recordsLag": 0,
          "status": 0
        }
      },
      "property2": {
        "timeseries": {
          "latency": [],
          "recordsLag": [],
          "status": []
        },
        "latest": {
          "latency": 0,
          "recordsLag": 0,
          "status": "string"
        },
        "timesummary": {
          "latency": 0,
          "recordsLag": 0,
          "status": 0
        }
      }
    },
    "property2": {
      "property1": {
        "timeseries": {
          "latency": [],
          "recordsLag": [],
          "status": []
        },
        "latest": {
          "latency": 0,
          "recordsLag": 0,
          "status": "string"
        },
        "timesummary": {
          "latency": 0,
          "recordsLag": 0,
          "status": 0
        }
      },
      "property2": {
        "timeseries": {
          "latency": [],
          "recordsLag": [],
          "status": []
        },
        "latest": {
          "latency": 0,
          "recordsLag": 0,
          "status": "string"
        },
        "timesummary": {
          "latency": 0,
          "recordsLag": 0,
          "status": 0
        }
      }
    }
  },
  "topic_metrics": {
    "property1": {
      "property1": {
        "timeseries": {
          "latency": [],
          "recordsLag": [],
          "status": []
        },
        "latest": {
          "latency": 0,
          "recordsLag": 0,
          "status": "string"
        },
        "timesummary": {
          "latency": 0,
          "recordsLag": 0,
          "status": 0
        }
      },
      "property2": {
        "timeseries": {
          "latency": [],
          "recordsLag": [],
          "status": []
        },
        "latest": {
          "latency": 0,
          "recordsLag": 0,
          "status": "string"
        },
        "timesummary": {
          "latency": 0,
          "recordsLag": 0,
          "status": 0
        }
      }
    },
    "property2": {
      "property1": {
        "timeseries": {
          "latency": [],
          "recordsLag": [],
          "status": []
        },
        "latest": {
          "latency": 0,
          "recordsLag": 0,
          "status": "string"
        },
        "timesummary": {
          "latency": 0,
          "recordsLag": 0,
          "status": 0
        }
      },
      "property2": {
        "timeseries": {
          "latency": [],
          "recordsLag": [],
          "status": []
        },
        "latest": {
          "latency": 0,
          "recordsLag": 0,
          "status": "string"
        },
        "timesummary": {
          "latency": 0,
          "recordsLag": 0,
          "status": 0
        }
      }
    }
  }
}