Skip to content
Graft Docs

Dashboards

Widget layouts for the overview screen.

GET /api/v1/dashboards

Section titled “GET /api/v1/dashboards”

List dashboards. Cursor-paginated: pass limit (default 25, max 100) and cursor from the previous response’s meta.cursor.

Auth: Bearer token

POST /api/v1/dashboards

Section titled “POST /api/v1/dashboards”

Create a dashboard. Widget type is record_list, kpi, calendar or chart, with a grid layout of x, y, w, h.

Auth: Bearer token

Request body

{
  "name": "Overview",
  "widgets": [
    {
      "id": "w1",
      "type": "kpi",
      "config": {},
      "layout": {
        "x": 0,
        "y": 0,
        "w": 3,
        "h": 1
      }
    }
  ]
}

GET /api/v1/dashboards/:dashboardId

Section titled “GET /api/v1/dashboards/:dashboardId”

One dashboard.

Auth: Bearer token · Path parameters: dashboardId

PATCH /api/v1/dashboards/:dashboardId

Section titled “PATCH /api/v1/dashboards/:dashboardId”

Rename it or replace its widgets (max 40).

Auth: Bearer token · Path parameters: dashboardId

Request body

{
  "name": "Operations"
}

DELETE /api/v1/dashboards/:dashboardId

Section titled “DELETE /api/v1/dashboards/:dashboardId”

Delete a dashboard.

Auth: Bearer token · Path parameters: dashboardId