Fleet aggregate ingress/egress (bits/sec) over time.

GET

/api/v1/metrics/throughput-range

curl --request GET \
  --url https://example.com/api/v1/metrics/throughput-range \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearer

Parameters

Query Parameters

from

integer format: int64

to

integer format: int64

step

integer format: int64

Responses

200

Fleet ingress and egress aligned on one timestamp axis

Media typeapplication/json

Fleet aggregate ingress and egress, aligned onto one shared timestamp axis.

Both arrays are the same length as timestamps, with null where that side has no sample. The chart draws two series against one x-axis, so aligning here rather than client-side is what keeps a missing ingress point from silently shifting egress by one slot.

object

in_bps

required

Array<number | null>

out_bps

required

Array<number | null>

timestamps

required

Array<integer>

Example^generated

{
  "in_bps": [
    1
  ],
  "out_bps": [
    1
  ],
  "timestamps": [
    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"
  }
}