v1

latestOpenAPI 3.1.02026-07-24318141.2 MB
Dashboards

Get Dashboard

Returns the details of a dashboard, including all the reports inside it. You need the id (dashcard_id) and card_id from each report to download its data via the dashboard download endpoint.

get/api/dashboard/{dashboard_id}

Path parameters

{"stackTrail":"paths:/api/dashboard/{dashboard_id}:get:parameters:0:schema","oasType":"schema","type":"unknown"}

Dashboard ID from GET /api/collection/{id}/items — look for items where model is "dashboard".

Response

Dashboard metadata with the full Dashcard list.

idinteger

Dashboard ID.

namestring

Dashboard name.

descriptionstring nullable

Optional description.