Expand description
Official IC Dashboard API report models, adapters, builders, and renderers.
Structs§
- IcBoundary
Node Data Center Row - IcBoundaryNodeDataCenterRow
- IcBoundary
Node Data Centers Report - IcBoundaryNodeDataCentersReport
- IcBoundary
Node Data Centers Request - IcBoundaryNodeDataCentersRequest
- IcCanister
Count Report - IcCanisterCountReport
- IcCanister
Count Request - IcCanisterCountRequest
- IcCanister
Filters - IcCanisterFilters
- IcCanister
Page Controller - IcCanisterPageController
- IcCanister
Page Report - IcCanisterPageReport
- IcCanister
Page Request - IcCanisterPageRequest
- IcCanister
Page Row - IcCanisterPageRow
- IcCanister
Report - IcCanisterReport
- IcCanister
Request - IcCanisterRequest
- IcCanister
Upgrade - IcCanisterUpgrade
- IcDaily
Stats Query - IcDailyStatsQuery
- IcDaily
Stats Report - IcDailyStatsReport
- IcDaily
Stats Request - IcDailyStatsRequest
- IcDaily
Stats Row - IcDailyStatsRow
- IcDashboard
Report Provenance - IcDashboardReportProvenance
- IcIcrc
Analytics Request - IcIcrcAnalyticsRequest
- IcIcrc
Indexed Count Report - IcIcrcIndexedCountReport
- IcIcrc
Indexed Count Request - IcIcrcIndexedCountRequest
- IcIcrc
Token Value Query - IcIcrcTokenValueQuery
- IcIcrc
Token Value Report - IcIcrcTokenValueReport
- IcIcrc
Token Value Request - IcIcrcTokenValueRequest
- IcIcrc
Token Value Row - IcIcrcTokenValueRow
- IcIcrc
Total Supply Observation - IcIcrcTotalSupplyObservation
- IcIcrc
Total Supply Query - IcIcrcTotalSupplyQuery
- IcIcrc
Total Supply Report - IcIcrcTotalSupplyReport
- IcIcrc
Total Supply Request - IcIcrcTotalSupplyRequest
- IcMetric
Observation - IcMetricObservation
- IcMetric
Query - IcMetricQuery
- IcMetric
Report - IcMetricReport
- IcMetric
Request - IcMetricRequest
- IcMetric
Series - IcMetricSeries
- IcNode
Assignment Status Counts - IcNodeAssignmentStatusCounts
- IcNode
Count Comparison Counts - IcNodeCountComparisonCounts
- IcNode
Provider Status Report - IcNodeProviderStatusReport
- IcNode
Provider Status Row - IcNodeProviderStatusRow
- IcNode
Status Cache Evidence - IcNodeStatusCacheEvidence
- IcNode
Status Counts - IcNodeStatusCounts
- IcNode
Status Group Counts - IcNodeStatusGroupCounts
- IcNode
Status Observation - IcNodeStatusObservation
- IcNode
Status Report - IcNodeStatusReport
- IcNode
Status Row - IcNodeStatusRow
- IcNode
Status Snapshot - IcNodeStatusSnapshot
- IcNode
Status Snapshot Request - IcNodeStatusSnapshotRequest
- IcNode
Status View - IcNodeStatusView
- IcSubnet
Status Report - IcSubnetStatusReport
- IcSubnet
Status Row - IcSubnetStatusRow
Enums§
- IcIcrc
Indexed Count Kind - IcIcrcIndexedCountKind
- IcMetric
Kind - IcMetricKind
- IcNode
Count Comparison - IcNodeCountComparison
- IcNode
Operational Status - IcNodeOperationalStatus
- IcNode
Status Projection Error - IcNodeStatusProjectionError
- IcNode
Status Scope - IcNodeStatusScope
Constants§
- DEFAULT_
ICRC_ ANALYTICS_ SOURCE_ ENDPOINT - Default base endpoint for the official Dashboard ICRC analytics API.
- DEFAULT_
ICRC_ TOKEN_ VALUE_ LIMIT - Default row limit for one ICRC token-value analytics query.
- DEFAULT_
ICRC_ TOKEN_ VALUE_ WINDOW_ SECS - Default relative window for one ICRC token-value analytics query.
- DEFAULT_
ICRC_ TOTAL_ SUPPLY_ STEP_ SECS - Default interval between ICRC total-supply observations.
- DEFAULT_
ICRC_ TOTAL_ SUPPLY_ WINDOW_ SECS - Default relative window for one ICRC total-supply analytics query.
- DEFAULT_
IC_ BOUNDARY_ NODE_ DATA_ CENTERS_ SOURCE_ ENDPOINT - Default base endpoint for official boundary-node data-center queries.
- DEFAULT_
IC_ CANISTER_ PAGE_ LIMIT - Default row limit for one official Dashboard canister page.
- DEFAULT_
IC_ DAILY_ STATS_ WINDOW_ SECS - Default relative window for one Dashboard daily-statistics query.
- DEFAULT_
IC_ DASHBOARD_ CANISTER_ COLLECTION_ SOURCE_ ENDPOINT - Default base endpoint for official IC Dashboard canister collection queries.
- DEFAULT_
IC_ DASHBOARD_ METRICS_ SOURCE_ ENDPOINT - Default base endpoint for the official IC Dashboard Metrics API.
- DEFAULT_
IC_ DASHBOARD_ SOURCE_ ENDPOINT - Default base endpoint for the official IC Dashboard API.
- DEFAULT_
IC_ METRIC_ STEP_ SECS - Default interval between requested Dashboard metric observations.
- DEFAULT_
IC_ METRIC_ WINDOW_ SECS - Default relative window for one Dashboard metric query.
- DEFAULT_
IC_ NODE_ STATUS_ REFRESH_ LOCK_ STALE_ SECONDS - Age after which an abandoned node-status refresh lock is stale.
- DEFAULT_
IC_ NODE_ STATUS_ STALE_ AFTER_ SECONDS - Age after which an observed node-status cache refreshes automatically.
- IC_
NODE_ STATUS_ SCHEMA_ VERSION - Current schema version for observed node-status reports and caches.
- MAX_
ICRC_ ANALYTICS_ OBSERVATIONS - Maximum requested observations accepted for one ICRC analytics series.
- MAX_
ICRC_ TOKEN_ VALUE_ ROWS - Maximum token-value rows requested or accepted by one report.
- MAX_
ICRC_ TOKEN_ VALUE_ WINDOW_ SECS - Largest time window accepted for one ICRC token-value query.
- MAX_
IC_ BOUNDARY_ NODE_ DATA_ CENTERS - Maximum boundary-node data-center rows accepted from one source response.
- MAX_
IC_ CANISTER_ PAGE_ LIMIT - Maximum row limit accepted for one official Dashboard canister page.
- MAX_
IC_ DAILY_ STATS_ ROWS - Maximum daily-statistics rows accepted from one source response.
- MAX_
IC_ DAILY_ STATS_ WINDOW_ SECS - Largest time window accepted by one daily-statistics request.
- MAX_
IC_ DASHBOARD_ RESPONSE_ BYTES - Maximum response-body size accepted from an official Dashboard HTTP endpoint.
- MAX_
IC_ METRIC_ OBSERVATIONS_ PER_ SERIES - Maximum requested observations accepted per metric series.
- MAX_
IC_ METRIC_ STEP_ SECS - Largest step accepted by the official Dashboard Metrics API.
- MAX_
IC_ NODE_ STATUS_ ROWS - Maximum rows accepted from the finite Dashboard node resource.
- MIN_
ICRC_ ANALYTICS_ TIMESTAMP - Earliest timestamp accepted by the official Dashboard ICRC analytics API.
- MIN_
IC_ DAILY_ STATS_ TIMESTAMP - Earliest timestamp accepted by the official Dashboard daily-statistics API.
- MIN_
IC_ METRIC_ TIMESTAMP - Earliest timestamp accepted by the official Dashboard Metrics API.
Functions§
- ic_
boundary_ node_ data_ centers_ report_ text - Render one official boundary-node data-center report as human-facing text.
- ic_
canister_ count_ report_ text - Render one official Dashboard canister-count report as human-facing text.
- ic_
canister_ page_ report_ text - Render one bounded official Dashboard canister page as human-facing text.
- ic_
canister_ report_ text - Render one official Dashboard canister report as human-facing text.
- ic_
daily_ stats_ report_ text - Render one bounded official Dashboard daily-statistics report as human-facing text.
- ic_
metric_ report_ text - Render one bounded official Dashboard metric report as human-facing text.
- ic_
node_ provider_ status_ report_ from_ snapshot - Project a node-provider status report from one complete observed snapshot.
- ic_
node_ provider_ status_ report_ text - Render a human-readable node-provider operational status report.
- ic_
node_ status_ report_ from_ snapshot - Project a node-level status report from one complete observed snapshot.
- ic_
node_ status_ report_ text - Render a human-readable node-level operational status report.
- ic_
subnet_ status_ report_ from_ snapshot - Project a Subnet-level status report from one complete observed snapshot.
- ic_
subnet_ status_ report_ text - Render a human-readable Subnet operational status report.
- icrc_
indexed_ count_ report_ text - Render one official ICRC indexed-count report as human-facing text.
- icrc_
token_ value_ report_ text - Render one bounded official ICRC token-value series as human-facing text.
- icrc_
total_ supply_ report_ text - Render one bounded official ICRC total-supply series as human-facing text.