Sign in
Dashboards

Render a dashboard

Changed on

Run a saved dashboard's queries over one time window and return its layout with one outcome per requested component (ok, empty, rejected, or error). Omit timeRange for the dashboard's default window, revision for the current one, and componentIds for every bound component.

post/dashboards/{id}/render

Request

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

Path parameters

idstring uuid required

Request body

revisioninteger

Loaded revision; omission snapshots the current one.

componentIdsstring[]

Omission renders every artifact-bound component; an empty list returns the layout and runs no query.

projectIdstring uuid

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

Response

OK

idstring uuid required
revisioninteger required
definitionHashstring required
titlestring required
descriptionstring required
requestedComponentIdsstring[] required
artifactsobject required

Changes

  • 88bb1e570de3Revision changes
    • ○

      added subschema #1 subschema #2 subschema #3 to the / response property anyOf list for the response status

    • ○

      removed subschema #1 subschema #2 subschema #3 from the / response property anyOf list for the response status

  • 91462dbc8cebRevision changes
    • ○

      added subschema #1 subschema #2 subschema #3 to the / response property anyOf list for the response status

    • ○

      removed subschema #1 subschema #2 subschema #3 from the / response property anyOf list for the response status