Get Usage Metrics

Fetch detailed usage metrics for the organisation.

GET/billing/usage/metrics

Authorization

AuthorizationBearer token · headerrequired

Query parameters

page_sizeinteger

pageinteger

sortstring

default: "asc"

Allowed:ascdesc

idstring

connectorstring

Source connector name. Example: postgresql, mysql, ...

partial_namestring

Enter the source name you want to search for

tenant_idsstring

A comma-separated list of Tenant IDs

entity_typestring

default: "sources"

Request body

application/json

Any of:

GetUsageMetricsReqBody

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

object

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/billing/usage/metrics' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "tenant_ids": [
    "string"
  ]
}'

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

import requests

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

Response

{}

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