You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "chandug1991 (via GitHub)" <gi...@apache.org> on 2025/06/05 18:04:24 UTC
[I] Dynamically get the Embeded dashboard UUID's for a Logged in User.. [superset]
chandug1991 opened a new issue, #33705:
URL: https://github.com/apache/superset/issues/33705
### Bug description
### Summary
There is no documented or discoverable REST endpoint that returns the
**embedded-dashboard UUIDs** for dashboards that have “Allow Embedding”
enabled.
The standard list endpoint (`/api/v1/dashboard/`) returns dashboard metadata
but omits the UUID required for guest-token generation.
### Superset version/environment
* Superset 4.1.2 (Docker image `apache/superset:4.1.2`)
* Feature flags in `config.py`
```python
FEATURE_FLAGS = {
"EMBEDDED_SUPERSET": True,
"GUEST_TOKEN": True,
}
### Steps to reproduce
Enable Allow Embedding on one or more dashboards (UI or PUT request).
Call
bash
Copy
Edit
GET /api/v1/dashboard/?q=(columns:(id,dashboard_title)) or GET /api/v1/dashboard/
Inspect each dashboard object in the JSON response.
Expected result
Each dashboard that is embeddable exposes either
It's an embedded UUID or a link/reference to fetch it.
Actual result
The UUID (or any indication that the dashboard is embeddable) is missing.
Impact
Guest-token flows in client apps (e.g. React with
@superset-ui/embedded-sdk) cannot discover which dashboards can be embedded.
The only workaround is hard-coding UUIDs or querying the metadata DB directly.
Additional context / attempted work-arounds
Tried GET /api/v1/dashboard/<id> – still no UUID.
Verified that embedded_dashboard rows exist in the metadata DB and contain
the UUID + dashboard_id link.
The deprecated /superset/embedded_dashboard/<uuid> endpoint is legacy and
does not list dashboards.
### Screenshots/recordings
_No response_
### Superset version
master / latest-dev
### Python version
3.9
### Node version
16
### Browser
Chrome
### Additional context
_No response_
### Checklist
- [ ] I have searched Superset docs and Slack and didn't find a solution to my problem.
- [ ] I have searched the GitHub issue tracker and didn't find a similar bug report.
- [ ] I have checked Superset's logs for errors and if I found a relevant Python stacktrace, I included it here as text in the "additional context" section.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [I] Dynamically get the Embeded dashboard UUID's for a Logged in User.. [superset]
Posted by "rusackas (via GitHub)" <gi...@apache.org>.
rusackas commented on issue #33705:
URL: https://github.com/apache/superset/issues/33705#issuecomment-3731034458
Closing this out since we haven't heard back, but happy to revisit if/when needed. Thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [I] Dynamically get the Embeded dashboard UUID's for a Logged in User.. [superset]
Posted by "msyavuz (via GitHub)" <gi...@apache.org>.
msyavuz commented on issue #33705:
URL: https://github.com/apache/superset/issues/33705#issuecomment-3183561864
@chandug1991 There is the `/api/v1/dashboard/{id_or_slug}/embedded` endpoint which should return the uuid. Also you can explore the api endpoints in https://superset.apache.org/docs/api/
Let us know if this helps
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [I] Dynamically get the Embeded dashboard UUID's for a Logged in User.. [superset]
Posted by "rusackas (via GitHub)" <gi...@apache.org>.
rusackas closed issue #33705: Dynamically get the Embeded dashboard UUID's for a Logged in User..
URL: https://github.com/apache/superset/issues/33705
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [I] Dynamically get the Embeded dashboard UUID's for a Logged in User.. [superset]
Posted by "dosubot[bot] (via GitHub)" <gi...@apache.org>.
dosubot[bot] commented on issue #33705:
URL: https://github.com/apache/superset/issues/33705#issuecomment-2945540351
<!-- Answer -->
You can retrieve the embedded dashboard UUID for a dashboard with "Allow Embedding" enabled by calling the endpoint [`/api/v1/dashboard/<id_or_slug>/embedded`](https://github.com/apache/superset/blob/b00660acf13e8bb99ba22d61636a793eae0867a9/superset/dashboards/api.py#L1). This endpoint returns the UUID if embedding is enabled for that dashboard; otherwise, it returns a 404. You'll need to call this endpoint for each dashboard you want to check—there isn't a bulk endpoint for all embeddable dashboards.
Example request:
```http
GET /api/v1/dashboard/<dashboard_id_or_slug>/embedded
Authorization: Bearer <your-access-token>
```
The response will include the UUID in the `result.uuid` field if embedding is enabled.
If you have direct access to the metadata database, you can also query the `embedded_dashboards` table, where the UUID is stored in binary format. To convert it to a string in Python:
```python
import uuid
def convert_binary_uuid_to_string(binary_uuid):
return str(uuid.UUID(bytes=binary_uuid))
```
For more details, see this [discussion](https://github.com/apache/superset/discussions/32125) and the [API implementation](https://github.com/apache/superset/blob/b00660acf13e8bb99ba22d61636a793eae0867a9/superset/dashboards/api.py#L1).
<!-- Dosu Comment Footer -->
*To reply, just mention [@dosu](https://go.dosu.dev/dosubot).*
---
<sup>How did I do? [Good](https://app.dosu.dev/response-feedback/984f965d-82d9-4d2f-8c1c-e11ac51832b8?feedback_type=great_response) | [Irrelevant](https://app.dosu.dev/response-feedback/984f965d-82d9-4d2f-8c1c-e11ac51832b8?feedback_type=irrelevant_answer) | [Incorrect](https://app.dosu.dev/response-feedback/984f965d-82d9-4d2f-8c1c-e11ac51832b8?feedback_type=incorrect_sources) | [Verbose](https://app.dosu.dev/response-feedback/984f965d-82d9-4d2f-8c1c-e11ac51832b8?feedback_type=too_verbose) | [Hallucination](https://app.dosu.dev/response-feedback/984f965d-82d9-4d2f-8c1c-e11ac51832b8?feedback_type=hallucination) | [Report 🐛](https://app.dosu.dev/response-feedback/984f965d-82d9-4d2f-8c1c-e11ac51832b8?feedback_type=bug_report) | [Other](https://app.dosu.dev/response-feedback/984f965d-82d9-4d2f-8c1c-e11ac51832b8?feedback_type=other)</sup> [](https://go.dosu.dev/discord-bot) [!
[Share on X](https://img.shields.io/badge/X-share-black)](https://twitter.com/intent/tweet?text=%40dosu_ai%20helped%20me%20solve%20this%20issue!&url=https%3A//github.com/apache/superset/issues/33705)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org