Documentation by ClonePartner

Start typing to search.

API Reference

Execute multiple widget data queries in one request

View Markdown
POST /api/dashboards/{id}/widgets/data

Parses the dashboard YAML once, loads job context once, reuses connector instances, and runs selected widgets with a concurrency cap. Per-widget errors are returned inline without failing the whole batch.

Operation IDexecuteDashboardWidgets

Authentication

  • BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Request body

Content typeapplication/json

requestobject
1 property
widget_idsarray<string>

Subset of widget ids to refresh (defaults to all data widgets)

Array items
itemstring

Success response body

200Per-widget data or errors

Per-widget data or errors

Content typeapplication/json

responseobject
1 property
widgetsobject
Additional properties
valueobject
2 properties
dataunknown

Widget-specific payload when the query succeeded

errorstring

Error message when this widget failed (other widgets may still succeed)

Error responses

400Validation error

Validation error

Content typeapplication/json

responseobject
2 properties
errorstring
Example
NOT_FOUND
messagestring
Example
Resource not found
Example response
{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}

404Resource not found

Resource not found

Content typeapplication/json

responseobject
2 properties
errorstring
Example
NOT_FOUND
messagestring
Example
Resource not found
Example response
{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}