Dashboard API

VNB overview — aggregated dashboard data for one grid operator

Returns VNB identity, KPIs (installations, capacity, EWK scores, MaStR quality), latest agent results (MaStR Quality, Grid Connection, Energy Sharing, Redispatch), active VNB Monitor alerts, and datapoint health — all in a single call.

Two-phase execution: Phase 1 runs grid-operations.vnbLookupCodes and vnb-monitor.snapshot sequentially (MCP-intensive, ≤10 concurrent sessions). Phase 2 fires datapoint.health and four agent list calls in parallel (PouchDB-only). gridOperatorId from Phase 1 is forwarded to Phase 2 list calls.

If any upstream service is unavailable, the affected fields are set to null and the service name is appended to _errors.

Cache TTL: 5 minutes (key: bdewCode). Stampede-safe: concurrent requests for the same bdewCode share a single in-flight fetch promise.

get/api/dashboard/vnb-overview

Request

Base URL: https://api.cernion.de
URL: https://api.cernion.de/api/dashboard/vnb-overview
Auth: none declared

Query parameters

bdewCodestring required

Example:9907473000008

BDEW code of the grid operator

tokenstring

Optional Cernion MCP token as URL query parameter. If provided, it overrides CERNION_TOKEN for this request. Prefer Authorization Bearer header in production to reduce token exposure in URLs/logs.

Response

Aggregated VNB overview

kpisobject nullable

Key performance indicators aggregated from VNB Monitor and Datapoint health

timestampstring date-time

_errorsstring[]

Internal services that failed — corresponding fields are null

Example response

{
  "identity": {
    "name": "STROMDAO Netze GmbH",
    "mastrId": "SNB935578300972",
    "bdew": "9907473000008"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.