API Reference
API Reference

Post Fetch Info

METHOD: POST URL: /dashboard/fetch_info ARGUMENTS: None RETURNS: Dashboard info for embedding

POST/api/v1/dashboards/fetch_info

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Query parameters

dashboard_name string query required

Responses

200Successful Response

application/json

response DashboardTokenResponse required
7 fields
embedded_idstringrequired

Superset embedded ID of the dashboard

guest_tokenstringrequired

Superset guest token of the dashboard

namestringrequired

Name of the dashboard

display_namestringrequired

Display name of the dashboard

superset_urlstringrequired

Base Superset URL of the dashboard

rankintegerrequired

Dashboard importance (0 is the highest)

labelstringrequired

Dashboard label. Typically "report" or "dashboard"

Response example
{
  "embedded_id": "string",
  "guest_token": "string",
  "name": "string",
  "display_name": "string",
  "superset_url": "string",
  "rank": 0,
  "label": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}