Dashboard

This section provides an overview of all available APIs that adhere to the OpenAPI specification. All APIs are loaded from the OpenAPI specification file: Link. Please note that the API base-paths may differ depending on the connector, the specific API base-path can be seen in the UI dashboard.

---

get

Collect all data for the Dashboard Page

Responses

default

default response

application/json

get

/wrapper/ui/pages/dashboard-page

HTTPcURLJavaScriptPython

GET /api/management/wrapper/ui/pages/dashboard-page HTTP/1.1
Host: my-connector
Accept: */*

default

default response

{
  "numAssets": 1,
  "numPolicies": 1,
  "numContractDefinitions": 1,
  "numContractAgreementsConsuming": 1,
  "numContractAgreementsProviding": 1,
  "transferProcessesConsuming": {
    "numTotal": 1,
    "numRunning": 1,
    "numOk": 1,
    "numError": 1
  },
  "transferProcessesProviding": {
    "numTotal": 1,
    "numRunning": 1,
    "numOk": 1,
    "numError": 1
  },
  "managementApiUrlShownInDashboard": "text",
  "connectorEndpoint": "text",
  "connectorParticipantId": "text",
  "connectorTitle": "text",
  "connectorDescription": "text",
  "connectorCuratorUrl": "text",
  "connectorCuratorName": "text",
  "connectorMaintainerUrl": "text",
  "connectorMaintainerName": "text",
  "connectorDapsConfig": {
    "tokenUrl": "text",
    "jwksUrl": "text"
  },
  "connectorCxDidConfig": {
    "myDid": "text",
    "walletTokenUrl": "text",
    "trustedVcIssuer": "text",
    "bdrsUrl": "text",
    "dimUrl": "text"
  }
}

---

get

Basic KPIs about the running EDC Connector.

Responses

default

default response

application/json

get

/wrapper/use-case-api/kpis

HTTPcURLJavaScriptPython

GET /api/management/wrapper/use-case-api/kpis HTTP/1.1
Host: my-connector
Accept: */*

default

default response

{
  "assetsCount": 1,
  "policiesCount": 1,
  "contractDefinitionsCount": 1,
  "contractAgreementsCount": 1,
  "transferProcessDto": {
    "incomingTransferProcessCounts": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "outgoingTransferProcessCounts": {
      "ANY_ADDITIONAL_PROPERTY": 1
    }
  }
}