Documentation by ClonePartner

Start typing to search.

API Reference

Execute a widget data query

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

Resolves the job's connector mapping, evaluates JSONata in the widget config, and calls a readonly connector method. Response size is capped at 2 MB.

Operation IDexecuteDashboardWidget

Authentication

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

Path parameters

idintegerrequired

Resource ID

widgetIdstringrequired

Success response body

200Widget data

Widget data

Content typeapplication/json

responseobject
2 properties
widget_idstring
dataunknown

Widget-specific payload (count, rows, chart series, etc.)

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"
}