The operational signals: counts and ages, never a ledger fact. The operator's, with the read_signals kind.

GET

/v1/ops/signals

const url = 'https://example.com/v1/ops/signals';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/ops/signals \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Responses

200

The answer, from one consistent view (REQ-QR-2).

application/json

The operational signals (F-018, NFR-11): counts, ages and times, never a ledger fact. The operator’s, with the read_signals operator kind. Ages are in milliseconds at the time of the read.

object

anchor_in_flight_age

How long the checkpoint in flight has waited for finality, if one is.

integer | null format: uint64

anchor_incidents

Anchoring’s incidents, per kind (commitment_mismatch, unknown_anchor, position_difference); latest is not known for them and is zero.

Array<object>

default:

Incidents of one kind on the operator channel (F-013), for F-018’s signals.

object

count

required

How many were raised.

integer format: uint64

kind

required

The kind.

string

latest

required

When the latest was raised, in milliseconds.

integer format: uint64

anchor_lag

Anchor lag (F-017): time since the newest Final checkpoint was created; before the first is final, the age of the oldest checkpoint; absent while there is none.

integer | null format: uint64

audit

Any of:

object
null

The audit trail’s shipping to the audit store (T-013-13, REQ-AT-2, NFR-6), as the core reports it: counts, ages and flags, never a record.

object

backpressure

required

Whether the core refuses new inputs because its outbox is at its bound.

boolean

max_unshipped

required

That bound.

integer format: uint64

oldest_unshipped_age

The age of the oldest of them, by its time input; absent when none waits.

integer | null format: uint64

refused

required

Whether the store refused a record under its rules, or holds another record than the core’s at its head: shipping has stopped.

boolean

shipped

required

Records the store holds.

integer format: uint64

store_up

required

Whether the last round reached the store.

boolean

unshipped

required

Records in the core’s audit outbox, not yet confirmed by the store.

integer format: uint64

book

Any of:

object
null

The book’s size, as the signals carry it: counts only, each kept by the collection that holds what it counts, so the read visits no record (T-018-11).

object

genesis_records

The records of the chainspec the book was founded on; absent for a book founded without one.

integer | null format: uint64

leaves

required

The leaves of the core’s service store: what the core host’s replica holds in memory.

integer format: uint64

records

required

The book’s records, in a chainspec’s unit (F-036): one for each identity, ledger account, grant, alias and operation the book holds, and one for each of its seed’s opening rows and credential imports. At genesis, the chainspec’s records and the few rows genesis itself writes; later, one more for each operation, identity, account, grant or alias.

integer format: uint64

completion_p50

Completion of commands at p50 and p99, in milliseconds, over ingress’s latest samples (NFR-15, amendment 0007); absent before the first. Ingress’s own, added by the surface.

integer | null format: uint64

completion_p99

See completion_p50. F-018 pages when it passes the 30 s ceiling.

integer | null format: uint64

core_halted

Whether the core has stopped deciding: halted on an input the Agent cannot apply (finding F18 of F-032), or stopped on an incident. Reads go on; every input waits Received.

boolean

incidents

required

Incidents on the operator channel, per kind.

Array<object>

Incidents of one kind on the operator channel (F-013), for F-018’s signals.

object

count

required

How many were raised.

integer format: uint64

kind

required

The kind.

string

latest

required

When the latest was raised, in milliseconds.

integer format: uint64

needs_review

required

Of which in Needs-Review.

integer format: uint64

now

required

When the signals were read.

integer format: uint64

oldest_open_age

The age of the oldest non-terminal operation (REQ-OP-8); absent when none is open.

integer | null format: uint64

oldest_undecided_age

The age of the oldest row ingress holds undecided — logged, not yet decided by the core (REQ-CS-7); absent when every row is decided. Ingress’s own, added by the surface.

integer | null format: uint64

oldest_undelivered_age

The age of the oldest undelivered notification; absent when none is owed.

integer | null format: uint64

open

required

Non-terminal operations.

integer format: uint64

received

required

Operations in Received in the core.

integer format: uint64

review

required

The review queue’s length (REQ-OP-6).

integer format: uint64

review_most_overdue

required

How far past its service level the most overdue entry is.

integer format: uint64

review_overdue

required

Of which past their service level.

integer format: uint64

review_service_level

required

The review queue’s service level.

integer format: uint64

settlement_comparison_age

The age of the latest settlement comparison.

integer | null format: uint64

settlement_differing

Assets whose latest settlement comparison differs (REQ-PR-5).

integer format: uint64

tick_age

The age of the last tick the core applied (DEC-6, RISK-7); absent before the first.

integer | null format: uint64

undelivered

required

Undelivered notifications (REQ-EV-6).

integer format: uint64

vos_unacknowledged

The core Agent’s runtime: Authority decisions (receipts) issued whose invocation is not acknowledged yet. The runtime refuses more past 256. Absent for the in-process core.

integer | null format: uint64

Example

{
  "anchor_incidents": [],
  "core_halted": false,
  "settlement_differing": 0
}

4XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

5XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

Headers

Retry-After

integer

On ERR-DecisionUnavailable (503): seconds to wait before retrying with the same client key (DEC-27 (g)).