POST
/
api
/
v1
/
dashboards
/
fetch_info
import os
from syllable_sdk import SyllableSDK


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

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

    # Handle response
    print(res)
{
  "embedded_id": "976ef486-d1ea-49c7-ba81-18e955d80286",
  "guest_token": "some-guest-token",
  "name": "session_summary",
  "display_name": "Session Summary",
  "superset_url": "https://somesuperseturl.com",
  "rank": 0,
  "label": "dashboard"
}

Authorizations

​
Syllable-API-Key
string
header
required

Query Parameters

​
dashboard_name
string
required

Response

200
application/json
Successful Response

Basic information about a dashboard.

​
embedded_id
string
required

Superset embedded ID of the dashboard

Example:

"976ef486-d1ea-49c7-ba81-18e955d80286"

​
guest_token
string
required

Superset guest token of the dashboard

Example:

"some-guest-token"

​
name
string
required

Name of the dashboard

Example:

"session_summary"

​
display_name
string
required

Display name of the dashboard

Example:

"Session Summary"

​
superset_url
string
required

Base Superset URL of the dashboard

Example:

"https://somesuperseturl.com"

​
rank
integer
required

Dashboard importance (0 is the highest)

Example:

0

​
label
string
required

Dashboard label. Typically "report" or "dashboard"

Example:

"dashboard"