POST
/
api
/
v1
/
dashboards
/
fetch_info
import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.v1.postGetDashboard({
    dashboardName: "<value>",
  });

  // Handle the result
  console.log(result);
}

run();
{
  "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

200
application/json
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

Superset URL of the dashboard

rank
integer
required

Dashboard importance, 0 is the highest

label
string
required

Dashboard label. Typically report or dashboard