Get DataLens dashboard
datalens_dashboards_getRetrieve a DataLens dashboard by ID, including its tabs, charts, selectors, and texts. Use it to inspect or edit dashboards; the returned data feeds dashboards_update.
Instructions
One dashboard: its tabs and the charts, selectors and texts on them.
A real dashboard is large, 100 KB and more, which may be over what a client shows of a
tool's reply: read a big one as a file (ycli datalens dashboards get <id> > dash.json).
entry.data is what dashboards_update takes back.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| branch | No | The version to read when no revision is named: `saved` or `published`. A save writes the saved one: read `saved` before changing a dashboard. | |
| rev_id | No | One revision to read, as it is; give it or `branch`, not both. | |
| workbook_id | No | The workbook the dashboard lies in. | |
| dashboard_id | Yes | Dashboard id. | |
| include_links | No | Also say what the dashboard is linked to. | |
| include_favorite | No | Also say whether the dashboard is a favourite. | |
| include_permissions | No | Also say what the caller may do with it. |