get_node_flow_series

GET

/api/v1/nodes/{node_id}/flow/series

curl --request GET \
  --url https://example.com/api/v1/nodes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/flow/series \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearer

Parameters

Path Parameters

node_id

required

string format: uuid

Exporter node id

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

Traffic trend: bytes and packets per protocol per 5-minute bucket

Media typeapplication/json

Array<object>

A trend point: bytes/packets for one protocol at one 5-minute bucket.

object

bytes

required

Bytes.

integer format: int64

packets

required

Packets.

integer format: int64

proto

required

IP protocol number.

integer format: int32

ts_unix_ms

required

Bucket start, Unix ms.

integer format: int64

Example^generated

[
  {
    "bytes": 1,
    "packets": 1,
    "proto": 1,
    "ts_unix_ms": 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"
  }
}