Sign in
Dashboards

Get a dashboard

Changed on

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/dashboards/{id}

Request

  • Base URL: https://api.sazabi.com/v1
  • URL: https://api.sazabi.com/v1/dashboards/{id}
  • Auth: none declared

Path parameters

idstring uuid required

Query parameters

boolean
OR
string
projectIdstring uuid

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

Response

OK

canUpdateViewSettingsboolean
idstring uuid required
revisioninteger required
definitionHashstring required
titlestring required
descriptionstring required
sourcestring required

MDX including an edit base when content editing is supported. Check dashboard capabilities before editing.

filesobject

Present exactly when includeFiles was requested.

Changes

  • b7c27d694271Revision changes
    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

  • faca1a7e107cRevision changes
    • ○

      endpoint added