API Reference

Execute multiple widget data queries on a shared dashboard

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

Execute multiple widget data queries on a shared dashboard

Operation IDexecutePublicDashboardWidgets

Authentication

No authentication is required.

Path parameters

tokenstringrequired

Request body

Content typeapplication/json

requestobject

1 property

widget_idsarray<string>

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

503Public dashboards disabled on this server

Public dashboards disabled on this server

No response content schema is documented.

Code examples

curl --request POST \
  --url 'https://your-envoy.example.com/api/public/dashboards/YOUR_TOKEN/widgets/data' \
  --header 'Content-Type: application/json' \
  --data '{
  "widget_ids": [
    "string"
  ]
}'

const response = await fetch("https://your-envoy.example.com/api/public/dashboards/YOUR_TOKEN/widgets/data", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "widget_ids": [
      "string"
    ]
  }),
});

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