Execute widget data on a shared dashboard

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

Operation ID: executePublicDashboardWidget

Authentication

No authentication is required.

Path parameters

token — string, required
widgetId — string, required

Success responses

200

Widget data

Content type: application/json

Reference: WidgetDataResponse
- Type: object
- Properties:
  - widget_id (string)
  - data (unknown) — Widget-specific payload (count, rows, chart series, etc.)

Error responses

400

Validation error

Content type: application/json

Reference: Error
- Type: object
- Properties:
  - error (string)
    - Example: NOT_FOUND
  - message (string)
    - Example: Resource not found

Example:

{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}

404

Resource not found

Content type: application/json

Reference: Error
- Type: object
- Properties:
  - error (string)
    - Example: NOT_FOUND
  - message (string)
    - Example: Resource not found

Example:

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

503

Public dashboards disabled

Examples

cURL

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

JavaScript (fetch)

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);