Skip to content
Yagra

Nodes generating the most alert fires over a trailing window (chronic offenders).

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
window
integer format: int64
limit
integer format: int64

Responses

Section titled “Responses”

200

Section titled “200”

Nodes ranked by alert fires; empty when this deployment keeps no history, and partial says the scope filter may have shortened the list

Media typeapplication/json

A ranked Top-N result.

object
entries
required

The ranked rows, highest first, at most the requested limit.

Array<object>

One chronic-offender row.

object
count
required
integer format: int64
name
required
string
node_id
required
string format: uuid
partial
required

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

boolean
Examplegenerated
{
  "entries": [
    {
      "count": 1,
      "name": "example",
      "node_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ],
  "partial": true
}

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"
  }
}