Get pipeline metrics (POST)

POST alternative for GET /pipelines/metrics. Use when URL length limits are exceeded (e.g., 100+ IDs). Supports both query parameters and request body. Body parameters take precedence over query parameters.

POST/pipelines/metrics

Authorization

AuthorizationBearer token · headerrequired

Query parameters

idstring | any

Entity identifier to fetch metrics for

topic_list_frominteger | any

Starting index for topic list pagination

topic_list_sizeinteger | any

Number of topics to return in the list

fromstring | integer | any

Starting key for cursor-based pagination

sizeinteger | any

Number of results to return

levelstring | any

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

pageinteger | string | any

Page number for pagination

timestamp_tostring | string<date-time> | any

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

timestamp_fromstring | string<date-time> | any

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

time_unitstring | any

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

time_intervalinteger | string | any

Time interval value for aggregation

time_typestring | any

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

tenant_idsstring | any

A comma-separated list of Tenant IDs

idsstring | any

A comma-separated list of pipeline IDs

snapshotstring | any

Snapshot status filter

sortstring | any

Field to sort results by

sort_dirstring | any

Sort direction: 'asc' or 'desc'

Request body

application/json

Any of:

PipelineMetricsReqBody

idsstring[] | string | any

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

any

any

tenant_idsstring[] | string | any

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

any

any

any

any

Responses

200

Successful Response

account_metricsobject | any

Show properties

Any of:

object

object

any

any

connector_metricsobject | any

Show properties

Any of:

object

object

any

any

inline_metricsobject | any

Show properties

Any of:

object

object

any

any

task_metricsobject | any

Show properties

Any of:

object

object

any

any

topic_metricsobject | any

Show properties

Any of:

object

object

any

any

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 POST "https://api.streamkap.com/pipelines/metrics" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "ids": [
    "string"
  ],
  "tenant_ids": [
    "string"
  ]
}'

const response = await fetch("https://api.streamkap.com/pipelines/metrics", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"ids\": [\n    \"string\"\n  ],\n  \"tenant_ids\": [\n    \"string\"\n  ]\n}"
});

import requests

response = requests.post(
    "https://api.streamkap.com/pipelines/metrics",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"ids\": [\n    \"string\"\n  ],\n  \"tenant_ids\": [\n    \"string\"\n  ]\n}",
)

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

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}