Sazabi
APIDashboards

Get a dashboard

Read a dashboard's current MDX source (with its edit base), metadata, and static file descriptors. Set includeFiles to also receive the static file contents, giving a copy you can edit and pass back to dashboards.update. Never runs queries.

GET https://api.sazabi.com/v1/dashboards/{id}

GET
/dashboards/{id}

Path Parameters

id*string
Formatuuid

Query Parameters

includeFiles?|

Also return complete static file contents for --out copies.

Defaultfalse
projectId?string

Project that owns the dashboard. Auto-filled from CLI and SDK context when omitted.

Formatuuid

Response Body

application/json

curl -X GET "https://example.com/dashboards/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "origin": {    "kind": "dashboard",    "dashboardId": "c82e502a-6fd0-41b6-83a8-d9fffe188952",    "revision": -9007199254740991,    "definitionHash": "string"  },  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "revision": -9007199254740991,  "definitionHash": "string",  "title": "string",  "description": "string",  "source": "string",  "fileDescriptors": [    {      "path": "string",      "type": "area_chart",      "bytes": 0,      "contentHash": "string"    }  ],  "files": {    "property1": {      "version": 1,      "type": "flame_chart",      "data": {        "items": [          {            "name": "string",            "parent": "string",            "value": 0,            "tone": "neutral",            "detail": "string"          }        ],        "unit": "string",        "title": "string"      }    },    "property2": {      "version": 1,      "type": "flame_chart",      "data": {        "items": [          {            "name": "string",            "parent": "string",            "value": 0,            "tone": "neutral",            "detail": "string"          }        ],        "unit": "string",        "title": "string"      }    }  }}