Get Dashboard

Get a dashboard's widgets (and its link) by id.

Tool: draxlr_get_dashboard

Gets a dashboard's widgets by its id — useful for resolving a dashboard link (app.draxlr.com/dashboard/:databaseId/:dashboardGroupId) into the list of widgets it contains. The response includes a url to view the dashboard in Draxlr.

Parameters

ParameterTypeRequiredDescription
databaseIdstringYesThe database id (the :databaseId part of a /dashboard/:databaseId/:dashboardGroupId link)
dashboardGroupIdstringYesThe dashboard id (the :dashboardGroupId part of the link)

Example

"What's on this dashboard? app.draxlr.com/dashboard/665f1c2a9b1e4a0012ab34cd/665f2a119b1e4a0012abd100"

Arguments:

{
  "databaseId": "665f1c2a9b1e4a0012ab34cd",
  "dashboardGroupId": "665f2a119b1e4a0012abd100"
}

Response

{
  "dashboardGroupId": "665f2a119b1e4a0012abd100",
  "url": "https://app.draxlr.com/dashboard/665f1c2a9b1e4a0012ab34cd/665f2a119b1e4a0012abd100",
  "widgetCount": 2,
  "widgets": [
    {
      "name": "Orders by status",
      "displayType": "graph",
      "queryId": "6690aa11bc2e4a0012cd77ee",
      "isRaw": true,
      "description": null,
      "hasAccess": true
    },
    {
      "name": "Monthly revenue",
      "displayType": "table",
      "queryId": "6690ab42bc2e4a0012cd8123",
      "isRaw": true,
      "description": null,
      "hasAccess": true
    }
  ]
}
FieldDescription
dashboardGroupIdThe dashboard id
urlA link to view the dashboard in Draxlr
widgetCountNumber of widgets on the dashboard
widgetsThe widgets, each with its name, display type and query