Get dashboard embedding id programmatically

[pcarnelli]

Dear Superset collaborators and users, I wonder if there is way of obtaining the dashboard id needed for embedding in a programmatic way (e.g. using the CLI or querying a database) instead of having to get it through the UI. Thank you.

[dosubot[bot]]

Hey @pcarnelli! I'm here to help you with any issues or questions you have. I'm a bot designed to assist with bug fixes, answer questions, and guide you to become a contributor. Let me know how I can assist you today!

To obtain the dashboard embedding ID programmatically, you can use the Superset API endpoint /api/v1/dashboard/${idOrSlug}/embedded. This endpoint allows you to fetch dashboard metadata, including the embedding ID, by providing the dashboard's ID or slug. You will need to ensure that you have the necessary authentication and authorization, specifically the "read" permission, to access this endpoint ^[1][2].

Additionally, the embedding ID is stored in the embedded_dashboards table in the database, specifically in the uuid column, which serves as the primary key ^[3]. While there is no direct CLI command to retrieve the embedding ID, you can query this table directly if you have access to the database.

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Other}

[dosubot[bot]]

The convert_uuids function is designed to convert UUID objects to strings, which is useful for serialization purposes, such as when using yaml.safe_dump. To use this function, ensure you have the necessary imports:

import uuid
from typing import Any

Here is the complete function with the necessary imports:

import uuid
from typing import Any

def convert_uuids(obj: Any) -> Any:
    """
    Convert UUID objects to str so we can use yaml.safe_dump
    """
    if isinstance(obj, uuid.UUID):
        return str(obj)

    if isinstance(obj, list):
        return [convert_uuids(el) for el in obj]

    if isinstance(obj, dict):
        return {k: convert_uuids(v) for k, v in obj.items()}

    return obj

Make sure to include these imports in your script to ensure the function works correctly ^[1].

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Other}

[pcarnelli]

@dosu the function convert_uuids does not convert the uuid in the table embedded_dashboards into a string, it just returns the input value unchanged.

[dosubot[bot]]

The convert_uuids function is intended for converting uuid.UUID objects to strings, but it seems like the uuid in the embedded_dashboards table is stored as binary data. To convert a binary UUID to a string, you can use the following approach:

import uuid

def convert_binary_uuid_to_string(binary_uuid):
    # Convert the binary UUID to a UUID object
    uuid_obj = uuid.UUID(bytes=binary_uuid)
    # Convert the UUID object to a string
    return str(uuid_obj)

# Example usage
binary_uuid = b'\x12\x34\x56\x78\x90\xab\xcd\xef\x12\x34\x56\x78\x90\xab\xcd\xef'
uuid_str = convert_binary_uuid_to_string(binary_uuid)
print(uuid_str)

This function will correctly convert the binary UUID from the embedded_dashboards table to its string representation ^[1].

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Other}

[pcarnelli]

@dosu that worked. Now can you provide me a code to convert from a string to a binary UUID?

[dosubot[bot]]

To convert a string UUID back to a binary UUID, you can use the following code:

import uuid

def convert_string_to_binary_uuid(uuid_str):
    # Convert the string UUID to a UUID object
    uuid_obj = uuid.UUID(uuid_str)
    # Convert the UUID object to binary
    return uuid_obj.bytes

# Example usage
uuid_str = '12345678-90ab-cdef-1234-567890abcdef'
binary_uuid = convert_string_to_binary_uuid(uuid_str)
print(binary_uuid)

This function will convert a string representation of a UUID into its binary form.

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Other}

[pcarnelli]

To summarize this discussion, here it is a code snippet to programmatically set the dashboard ID for embedding using Python:

import uuid
import sqlite3

def convert_string_to_binary_uuid(uuid_str):
    uuid_obj = uuid.UUID(uuid_str)
    return uuid_obj.bytes

con = sqlite3.connect(<path_to_superset_db>)
cur = con.cursor()

uuid_string = <your_uuid_as_string> # This is the ID for embedding
uuid_binary = convert_string_to_binary_uuid(uuid_string)

# Fields of table embedded_dashboards are: created_on, changed_on, allow_domain_list,
# uuid, dashboard_id, changed_by_fk, created_by_fk
db_entry = (<created_on_timestamp>, <changed_on_timestamp>, "", uuid_binary, 1, 1, 1)

cur.execute("INSERT INTO embedded_dashboards VALUES (?, ?, ?, ?, ?, ?, ?)", db_entry)
con.commit()

con.close()