コンテンツにスキップ
Yagra

Busiest-links × time heatmap: picks the top interfaces by current throughput, then returns each link's throughput (bits/sec) over time on a shared timestamp axis.

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
from
integer format: int64
to
integer format: int64
step
integer format: int64

Responses

Section titled “Responses”

200

Section titled “200”

A links × time throughput grid on one shared timestamp axis

Media typeapplication/json

A links × time grid. values[i][j] is link i’s throughput at timestamps[j], so every row is the same length and the client can shade cells without bounds checks.

object
links
required
Array<string>
partial
required

true when the link set covers only the groups the calling account may see and links it is entitled to may be missing. Always false for an account with unrestricted visibility.

boolean
timestamps
required
Array<integer>
values
required
Array<Array<number>>
Examplegenerated
{
  "links": [
    "example"
  ],
  "partial": true,
  "timestamps": [
    1
  ],
  "values": [
    [
      1
    ]
  ]
}

401

Section titled “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
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Section titled “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
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}