GET
/
v4
/
applications
/
{application_spec_id}
/
dashboards
/
{dashboard_id}
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

const dashboard = await client.applications.dashboards.retrieve('application_spec_id', 'top_level_dashboard');

console.log(dashboard.id);
{
  "id": "<string>",
  "title": "<string>",
  "visualizations": [
    {
      "id": "<string>",
      "title": "<string>",
      "type": "scalar",
      "metric_id": "total_requests",
      "metadata": {
        "is_variant_specific_metric": false,
        "label_title_map": {},
        "label_color_map": {}
      }
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
application_spec_id
string
required
​
dashboard_id
enum<string>
required
Available options:
top_level_dashboard,
engagements_dashboard,
executions_dashboard,
variant_overview_dashboard

Response

200
application/json

Successful Response

The response is of type object.