API Reference

Execute widget data on a shared dashboard

POST /api/public/dashboards/{token}/widgets/{widgetId}/data

Execute widget data on a shared dashboard

Operation IDexecutePublicDashboardWidget

Authentication

No authentication is required.

Path parameters

tokenstringrequired

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

503Public dashboards disabled

Public dashboards disabled

No response content schema is documented.

Code examples

curl --request POST \
  --url 'https://your-envoy.example.com/api/public/dashboards/YOUR_TOKEN/widgets/YOUR_WIDGET_ID/data'

const response = await fetch("https://your-envoy.example.com/api/public/dashboards/YOUR_TOKEN/widgets/YOUR_WIDGET_ID/data", {
  method: "POST",
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);