graft dashboards

Widget layouts for the overview screen.

Note

This page is generated from Graft’s API catalogue. The same operations are in the Dashboards API reference. Run graft describe <command> for examples from the API test suite.

Command	Does
graft dashboards create	Create a dashboard.
graft dashboards delete	Delete a dashboard.
graft dashboards get	One dashboard.
graft dashboards list	List dashboards.
graft dashboards update	Rename it or replace its widgets (max 40).

graft dashboards create

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

Endpoint: POST /api/v1/dashboards

graft dashboards create -d '{"name":"Overview","widgets":[{"id":"w1","type":"kpi","config":{},"layout":{"x":0,"y":0,"w":3,"h":1}}]}'

graft dashboards delete <dashboardId>

Delete a dashboard.

Endpoint: DELETE /api/v1/dashboards/:dashboardId · Arguments: <dashboardId>

graft dashboards delete <dashboardId>

Asks for confirmation; pass --yes to skip it (required in scripts).

graft dashboards get <dashboardId>

One dashboard.

Endpoint: GET /api/v1/dashboards/:dashboardId · Arguments: <dashboardId>

graft dashboards get <dashboardId>

graft dashboards list

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

Endpoint: GET /api/v1/dashboards

graft dashboards list

Add --all to fetch every page.

graft dashboards update <dashboardId>

Rename it or replace its widgets (max 40).

Endpoint: PATCH /api/v1/dashboards/:dashboardId · Arguments: <dashboardId>

graft dashboards update <dashboardId> -d '{"name":"Operations"}'