Skip to main content
The dashboard query retrieves detailed information about a specific dashboard by its unique identifier.

​
Signature

dashboard(id: String!, scope: DashboardScope!, version: String): Dashboard!

​
Arguments

​
id
String!
required
The unique identifier of the dashboard to retrieve.
​
scope
DashboardScope!
required
The access level required for the dashboard. See DashboardScope.
​
version
String
Optional version identifier for retrieving a specific historical snapshot of the dashboard.

​
Response

Returns a Dashboard object containing the complete dashboard configuration and metadata. See Dashboard for the schema.

​
Usage example

This example shows how to retrieve a dashboard with editor access: 
query GetDashboard($id: String!, $scope: DashboardScope!) {
  dashboard(id: $id, scope: $scope) {
    id
    name
    description
    widgets {
      id
      title
      nlQuery
      widgetType
      layout {
        top
        left
        width
        height
      }
      visualization {
        id
        title
        type
      }
      summaryWidgetConfig{
        customInstructions
      }
    }
    filters {
      id
      parsedFilter {
        filterId
        operator
        lhs {
          displayName
        }
        rhs {
          literal {
            flattened {
              literal {
                value
              }
            }
          
          }
        }
      }
    }
    accessLevel
  }
}

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <jwt_token>" \
  -d '{
    "query": "query GetDashboard($id: String!, $scope: DashboardScope!) { dashboard(id: $id, scope: $scope) { id name description widgets { id title layout { top left width height } } accessLevel } }",
    "variables": {
      "id": "dashboard_123456789",
      "scope": "EDITOR"
    }
  }' \
  https://{ACCOUNT}.askwisdom.ai/graphql

{
  "data": {
    "dashboard": {
      "id": "dashboard_123456789",
      "name": "Sales Performance Dashboard",
      "description": "Monthly sales metrics and KPIs",
      "widgets": [
        {
          "id": "widget_987654321",
          "title": "Total Sales",
          "layout": {
            "top": 0,
            "left": 0,
            "width": 6,
            "height": 4
          }
        },
        {
          "id": "widget_96f27a852f55",
          "title": " ",
          "nlQuery": "",
          "widgetType": "WIDGET_TYPE_SUMMARY",
          "layout": {
            "top": 1,
            "left": 0,
            "width": 12,
            "height": 3,
          },
          "visualization": null,
          "summaryWidgetConfig": {
            "customInstructions": "User guidelines:Generate Short Summary",
          },
        },
      ],
      "filters": [
        {
          "id": "dashboard_123456789-filter_1234",
          "parsedFilter": {
            "filterId": "filter_1234",
            "operator": "FUNC_ILIKE",
            "lhs": {
              "displayName": "acc.ACCOUNT_NAME",
              "__typename": "LHS"
            },
            "rhs": {
              "literal": {
                "flattened": [
                  {
                    "literal": {
                      "value": "\"%Account%\"",
                    },
                  }
                ],
              },
            },
          },
        }
      ],
      "accessLevel": "EDITOR"
    }
  }
}

​
Next steps

Dashboards Query

Retrieve multiple dashboards

Update Dashboard

Modify dashboard properties

Dashboard Object

Complete dashboard schema