Add Query to Dashboard
Add a saved query as a widget to a Draxlr dashboard.
Tool: draxlr_add_query_to_dashboard
Adds a query as a widget to a dashboard. Use Save Query or List Saved Queries to get a queryId, and List Dashboards to get a dashboardGroupId.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
queryId | string | Yes | The query to add (from Save Query, Run Query, or List Saved Queries) |
dashboardGroupId | string | Yes | The dashboard to add the query to (from List Dashboards) |
displayType | string | No | How to display the widget: table, graph, or computedCard (default table) |
name | string | No | Optional widget title (overrides the query name) |
description | string | No | Optional widget description |
Example
"Add the Orders by status query to my Sales Overview dashboard as a graph."
Arguments:
{
"queryId": "6690aa11bc2e4a0012cd77ee",
"dashboardGroupId": "665f2a119b1e4a0012abd100",
"displayType": "graph"
}
Response
{
"message": "Query added to dashboard.",
"dashboardItemId": "669a0f77de1a4a0012ef4455",
"dashboardGroupId": "665f2a119b1e4a0012abd100",
"url": "https://app.draxlr.com/dashboard/665f1c2a9b1e4a0012ab34cd/665f2a119b1e4a0012abd100"
}
| Field | Description |
|---|---|
message | Confirmation message |
dashboardItemId | Id of the newly created dashboard widget |
dashboardGroupId | The dashboard the widget was added to |
url | A link to view the dashboard in Draxlr |