dashboardScreen

Get a dashboard screen to render in the form of a json list of sections containing cards or grouped cards each with an order attribute.

Arguments

accountNumber : String!


            required

The account number of the user.

dashboardId : ID!


            required

The ID of the dashboard type screen to return.

ledgerId : String

The ledger id associated to the account.

Deprecation

The 'ledgerId' field is deprecated.

Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A'

- Marked as deprecated on 2024-10-22.
- Scheduled for removal on or after 2025-06-25.

ledgerNumber : String

The ledger number associated to the account.

maxVersionSupported : Int!


            required

default: 1

The maximum version of dahshboard type screens supported by the client.

params : [BackendScreenParamInputType]

List of key-value pairs (strings) to pass as parameters to the screen.

propertyId : String

The property id associated to the account.

Returns

Dashboard

A list of components which comprise a dashboard screen.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query DashboardScreen(
  $accountNumber: String!,
  $dashboardId: ID!,
  $ledgerNumber: String,
  $maxVersionSupported: Int!,
  $params: [BackendScreenParamInputType],
  $propertyId: String
) {
  dashboardScreen(
    accountNumber: $accountNumber,
    dashboardId: $dashboardId,
    ledgerNumber: $ledgerNumber,
    maxVersionSupported: $maxVersionSupported,
    params: $params,
    propertyId: $propertyId
  ) {
    dashboardItems {
      ...SectionTypeFragment
    }
    id
    serialisedDashboardItems
    typename
  }
}

{
  "accountNumber": "A-186432D6",
  "dashboardId": "37572905",
  "ledgerNumber": "concern-item-citizen-resource-property",
  "maxVersionSupported": 33,
  "params": BackendScreenParamInputType,
  "propertyId": "18645526"
}

{
  "data": {
    "dashboardScreen": {
      "dashboardItems": [SectionType],
      "id": "69954386",
      "serialisedDashboardItems": "space-near-must-surface-law",
      "typename": "how-full-election-agency-position"
    }
  }
}