Skip to main content
GET
/
v4
/
applications
/
{application_spec_id}
/
dashboards
/
{dashboard_id}
Python
import os
from scale_gp import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
dashboard = client.applications.dashboards.retrieve(
    dashboard_id="top_level_dashboard",
    application_spec_id="application_spec_id",
)
print(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

Successful Response

id
string
required
title
string
required
visualizations
VisualizationDescriptor · object[]
required