get_flow_top_talkers

GET

/api/v1/flow/top-talkers

curl --request GET \
  --url https://example.com/api/v1/flow/top-talkers \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearer

Parameters

Query Parameters

from

integer format: int64

to

integer format: int64

limit

integer format: int32

proto

string

port

string

peer

string

asn

string

dir

string

Responses

200

Host addresses ranked by traffic

Media typeapplication/json

Array<object>

A top-talker: one host address with summed traffic.

object

addr

required

Host address (v4 or v6, normalized from ClickHouse’s v4-mapped form).

string

bytes

required

Bytes.

integer format: int64

flows

required

Distinct flows.

integer format: int64

packets

required

Packets.

integer format: int64

Example^generated

[
  {
    "addr": "example",
    "bytes": 1,
    "flows": 1,
    "packets": 1
  }
]

401

No valid bearer token

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Role lacks the read permission

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

503

Flow monitoring is not enabled (no flow store configured)

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}