Skip to content
Yagra

get_node_metric_range

GET
/api/v1/nodes/{node_id}/metrics/{metric}/range
curl --request GET \
  --url https://example.com/api/v1/nodes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/metrics/example/range \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
node_id
required
string format: uuid

Node id

metric
required
string

Metric name — a Prometheus identifier

Query Parameters

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

max ⇒ node-level aggregate of a per-entity table gauge; absent ⇒ scalar node series.

rate
boolean

true ⇒ per-second rate of a counter series instead of its stored values. Cannot be combined with agg.

Responses

Section titled “Responses”

200

Section titled “200”

The window’s points; empty when the slice has no samples

Media typeapplication/json

A time-series window for one node metric.

object
metric
required
string
node_id
required

Stable identifier for a monitored node.

A UUID, not a name or address — both of which can change over a node’s life.

string format: uuid
points
required
Array<object>

One point of a time series: Unix-seconds timestamp and value.

object
t
required

Unix timestamp in seconds.

integer format: int64
v
required

Sample value.

number format: double
Examplegenerated
{
  "metric": "example",
  "node_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "points": [
    {
      "t": 1,
      "v": 1
    }
  ]
}

400

Section titled “400”

The metric name is not an identifier, agg is unsupported, or rate and agg were combined

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

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