dashboard.get_widget_by_id
dashboard_get_widget_by_idRetrieve a specific widget from a Sisense dashboard using its dashboard and widget IDs. Returns the full widget object, or an error if the request fails.
Instructions
Retrieve a single widget by its dashboard and widget IDs. Sends GET /api/v1/dashboards/{dashboard_id}/widgets/{widget_id}. Returns the full widget object as returned by the Sisense API.
Returns: dict[str, Any] The widget object returned by the API, or {"error": "..."} on failure.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| widget_id | Yes | The ``oid`` of the widget to retrieve. | |
| admin_access | No | When ``True`` (default), appends ``?adminAccess=true`` to the request, allowing access to dashboards the API token user does not own. Some Sisense versions reject the ``adminAccess`` query parameter with HTTP 422 (strict query-schema validation); the request is then retried automatically without it. | |
| dashboard_id | Yes | The ``oid`` of the dashboard that contains the widget. |