Elements and publish state in one call. Two Mongo reads, no Sheets access.

elements[].error is usually null even for a broken element: render errors are written during a build and not persisted (workflow/controller.py:759). Read an element's /data to be certain it renders.

Parameters

Responses

Example request

curl -s -X GET "https://api.sheetgo.com/rest/beta/workflows/ID/dashboard" \
  -H "Authorization: Bearer $SHEETGO_API_KEY"

In the API's own docs: https://api.sheetgo.com/rest/reference/dashboards#get-rest-beta-workflows-id-dashboard

Create one or more dashboard elements, atomically.

The dashboard itself needs no creating — add_charts brings it into being with the first element (workflow/models.py:1806).

Every element is validated against the real spreadsheet before anything is written, and a single failure rejects the whole batch: a partial write would leave the caller diffing what landed. Validation uses the workflow owner's credentials, since those are what render the dashboard later.

Parameters

Request body (required)

application/json · array of object

Responses

Example request

curl -s -X POST "https://api.sheetgo.com/rest/beta/workflows/ID/dashboard/elements" \
  -H "Authorization: Bearer $SHEETGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d @body.json

In the API's own docs: https://api.sheetgo.com/rest/reference/dashboards#post-rest-beta-workflows-id-dashboard-elements

Remove one element.

Deleting the LAST element removes the dashboard and takes it offline: remove_chart sets workflow.dashboard = None and marks the publishing record deleted (workflow/models.py:1920, :1932). Adding an element later revives it with the same public_id, so the viewer URL survives.

Parameters

Responses

Example request

curl -s -X DELETE "https://api.sheetgo.com/rest/beta/workflows/ID/dashboard/elements/ELEMENT_ID" \
  -H "Authorization: Bearer $SHEETGO_API_KEY"

In the API's own docs: https://api.sheetgo.com/rest/reference/dashboards#delete-rest-beta-workflows-id-dashboard-elements-element-id

Build and return one element's values.

Bounded to a single element: get_workflow_dashboard filters dashboard['data'] down to the requested id, so this is one or two Sheets calls regardless of dashboard size. The element's controlKey is read from storage, never taken from the caller — get_chart_instance matches on it (workflow/dashboard/utils.py:20) and would find nothing without it.

page/per_page apply to table elements only.

Parameters

Responses

Example request

curl -s -X GET "https://api.sheetgo.com/rest/beta/workflows/ID/dashboard/elements/ELEMENT_ID/data" \
  -H "Authorization: Bearer $SHEETGO_API_KEY"

In the API's own docs: https://api.sheetgo.com/rest/reference/dashboards#get-rest-beta-workflows-id-dashboard-elements-element-id-data

Set shared, require_auth and auth_config.domain.

specific_users and visual_schema are rejected. The internal PUT emails every address in authConfig.specificUsers via SendGrid (dashboard/models.py:190); refusing the field is what keeps an API key from mailing arbitrary recipients. Both remain editable in the Sheetgo UI.

Stricter than the internal route, which requires only workflow access (workflow/views.py:936) and so lets a collaborator publish publicly.

Parameters

Request body (required)

application/json · object

Responses

Example request

curl -s -X PUT "https://api.sheetgo.com/rest/beta/workflows/ID/dashboard/publish" \
  -H "Authorization: Bearer $SHEETGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d @body.json

In the API's own docs: https://api.sheetgo.com/rest/reference/dashboards#put-rest-beta-workflows-id-dashboard-publish