Skip to main content
POST
/
api
/
v1
/
dashboards
/
fetch_info
Python (SDK)
import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.dashboards.post_get_dashboard(dashboard_name="<value>")

    # Handle response
    print(res)
{
  "embedded_id": "<string>",
  "guest_token": "<string>",
  "name": "<string>",
  "display_name": "<string>",
  "superset_url": "<string>",
  "rank": 123,
  "label": "<string>"
}

Authorizations

Syllable-API-Key
string
header
required

Query Parameters

dashboard_name
string
required

Response

Successful Response

Basic information about a dashboard.

embedded_id
string
required

Superset embedded ID of the dashboard

guest_token
string
required

Superset guest token of the dashboard

name
string
required

Name of the dashboard

display_name
string
required

Display name of the dashboard

superset_url
string
required

Base Superset URL of the dashboard

rank
integer
required

Dashboard importance (0 is the highest)

label
string
required

Dashboard label. Typically "report" or "dashboard"