Documentation | Evaluation Dashboards

Evaluation Dashboards

EvaluationDashboardsResource

Methods

client.evaluation_dashboards.create() ->

EvaluationDashboard

post/v5/evaluation-dashboards

Create a new evaluation dashboard for an evaluation or evaluation group

client.evaluation_dashboards.list() -> SyncCursorPage[

EvaluationDashboard

]

get/v5/evaluation-dashboards

List dashboards filtered by evaluation_id, evaluation_group_id, tags, creators, or search

client.evaluation_dashboards.retrieve(, ) ->

EvaluationDashboard

get/v5/evaluation-dashboards/{dashboard_id}

Get a single evaluation dashboard by ID

client.evaluation_dashboards.update(, ) ->

EvaluationDashboard

patch/v5/evaluation-dashboards/{dashboard_id}

Partially update dashboard metadata (name, description, widget_order)

Parameters

dashboard_id: str

description: Optional[str]

Dashboard description

name: Optional[str]

(maxLength: 256, minLength: 1)

Dashboard name

tags: Optional[

SequenceNotStr

[str]]

The tags associated with the entity

widget_order: Optional[

SequenceNotStr

[str]]

Ordered array of widget IDs (for reordering widgets)

Returns

EvaluationDashboard

id: str

Unique identifier of the dashboard

account_id: str

Account that owns this dashboard

created_at:

datetime

(format: date-time)

When the dashboard was created

created_by:

Identity

The identity that created the entity.

name: str

Dashboard name

tags: List[str]

The tags associated with the entity

updated_at:

datetime

(format: date-time)

When the dashboard was last updated

archived_at: Optional[datetime]

(format: date-time)

When the dashboard was archived (soft-deleted)

description: Optional[str]

Dashboard description

error_message: Optional[str]

Error message if computation failed

evaluation_group_id: Optional[str]

Evaluation group ID

evaluation_id: Optional[str]

Evaluation ID

object: Optional[Literal["evaluation_dashboard"]]

(default: "evaluation_dashboard")

widget_order: Optional[List[str]]

Ordered array of widget IDs

widget_results: Optional[List[

EvaluationDashboardWidgetResult

]]

Widget results for this dashboard. Populated with 'widget_results' view.

widgets: Optional[List[

EvaluationDashboardWidget

]]

Widgets associated with this dashboard. Populated with 'widgets' view.

Request example

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
evaluation_dashboard = client.evaluation_dashboards.update(
    dashboard_id="dashboard_id",
)
print(evaluation_dashboard.id)

200Example

{
  "id": "id",
  "account_id": "account_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "name": "name",
  "tags": [
    "string"
  ],
  "updated_at": "2019-12-27T18:11:19.117Z",
  "archived_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "error_message": "error_message",
  "evaluation_group_id": "evaluation_group_id",
  "evaluation_id": "evaluation_id",
  "object": "evaluation_dashboard",
  "widget_order": [
    "string"
  ],
  "widget_results": [
    {
      "id": "id",
      "account_id": "account_id",
      "computation_status": "pending",
      "created_at": "2019-12-27T18:11:19.117Z",
      "widget_id": "widget_id",
      "computation_job_id": "computation_job_id",
      "computed_at": "2019-12-27T18:11:19.117Z",
      "computed_result": {
        "foo": "bar"
      },
      "error_message": "error_message",
      "evaluation_group_id": "evaluation_group_id",
      "evaluation_id": "evaluation_id",
      "object": "evaluation_dashboard_widget_result",
      "widget": {
        "id": "id",
        "account_id": "account_id",
        "created_at": "2019-12-27T18:11:19.117Z",
        "title": "title",
        "type": "bar",
        "archived_at": "2019-12-27T18:11:19.117Z",
        "config": {
          "foo": "bar"
        },
        "object": "evaluation_dashboard_widget",
        "query": {
          "select": [
            {
              "expression": {
                "column": "column",
                "source": "source",
                "type": "COLUMN"
              },
              "alias": "alias"
            }
          ],
          "filter": {
            "conditions": [
              {
                "column": "column",
                "operator": "=",
                "value": {},
                "source": "source"
              }
            ],
            "logicalOperators": [
              "AND"
            ]
          },
          "groupBy": [
            "string"
          ],
          "limit": 1,
          "orderBy": [
            {
              "column": "column",
              "direction": "ASC",
              "source": "source"
            }
          ]
        }
      }
    }
  ],
  "widgets": [
    {
      "id": "id",
      "account_id": "account_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "title": "title",
      "type": "bar",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "config": {
        "foo": "bar"
      },
      "object": "evaluation_dashboard_widget",
      "query": {
        "select": [
          {
            "expression": {
              "column": "column",
              "source": "source",
              "type": "COLUMN"
            },
            "alias": "alias"
          }
        ],
        "filter": {
          "conditions": [
            {
              "column": "column",
              "operator": "=",
              "value": {},
              "source": "source"
            }
          ],
          "logicalOperators": [
            "AND"
          ]
        },
        "groupBy": [
          "string"
        ],
        "limit": 1,
        "orderBy": [
          {
            "column": "column",
            "direction": "ASC",
            "source": "source"
          }
        ]
      }
    }
  ]
}

client.evaluation_dashboards.delete() ->

EvaluationDashboard

delete/v5/evaluation-dashboards/{dashboard_id}

Soft delete an evaluation dashboard

Domain types

class EvaluationDashboard: ...

Evaluation Dashboards

Widgets

EvaluationDashboardsResource.WidgetsResource

Methods

client.evaluation_dashboards.widgets.create(, ) ->

EvaluationDashboardWidgetWithResult

post/v5/evaluation-dashboards/{dashboard_id}/widgets

Create a new widget, add it to the dashboard, and compute its results

client.evaluation_dashboards.widgets.update(, ) ->

EvaluationDashboardWidgetWithResult

patch/v5/evaluation-dashboards/{dashboard_id}/widgets/{widget_id}

Update a widget and compute its results. If the widget is only used by this dashboard, it is updated in place. If shared across multiple dashboards, a copy is created.

client.evaluation_dashboards.widgets.delete(, )

delete/v5/evaluation-dashboards/{dashboard_id}/widgets/{widget_id}

Remove a widget from the dashboard (does not delete the widget)

Domain types

class EvaluationDashboardWidget: ...

class EvaluationDashboardWidgetResult: ...

class EvaluationDashboardWidgetWithResult: ...

Response model for widget creation - includes widget and computed result