List Evaluation Dashboards
evaluation_dashboards.list(EvaluationDashboardListParams**kwargs) -> SyncCursorPage[EvaluationDashboard]
GET/v5/evaluation-dashboards
List dashboards in the caller’s account, paginated, with optional filters.
Filter to a single evaluation with evaluation_id or to a group with
evaluation_group_id; passing both is rejected, since a dashboard is bound to one
or the other. tags matches case-insensitively (values are lowercased before
lookup), created_by_ids filters by creator identity, and search matches the
dashboard name and tags. Archived dashboards are excluded unless include_archived
is true. The returned items carry only the dashboards’ own fields — widgets and
widget results are never embedded here; use the get-by-id endpoint with the
widgets/widget_results views to load those.
List Evaluation Dashboards
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
)
page = client.evaluation_dashboards.list()
page = page.items[0]
print(page.id){
"has_more": true,
"items": [
{
"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"
}
],
"evaluation_ids": [
"string"
],
"filter": {
"conditions": [
{
"column": "column",
"operator": "=",
"source": "source",
"value": "string"
}
],
"logicalOperators": [
"AND"
]
},
"groupBy": [
"string"
],
"latest_only": true,
"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"
}
],
"evaluation_ids": [
"string"
],
"filter": {
"conditions": [
{
"column": "column",
"operator": "=",
"source": "source",
"value": "string"
}
],
"logicalOperators": [
"AND"
]
},
"groupBy": [
"string"
],
"latest_only": true,
"limit": 1,
"orderBy": [
{
"column": "column",
"direction": "ASC",
"source": "source"
}
]
}
}
]
}
],
"total": 0,
"limit": 0,
"object": "list"
}Returns Examples
{
"has_more": true,
"items": [
{
"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"
}
],
"evaluation_ids": [
"string"
],
"filter": {
"conditions": [
{
"column": "column",
"operator": "=",
"source": "source",
"value": "string"
}
],
"logicalOperators": [
"AND"
]
},
"groupBy": [
"string"
],
"latest_only": true,
"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"
}
],
"evaluation_ids": [
"string"
],
"filter": {
"conditions": [
{
"column": "column",
"operator": "=",
"source": "source",
"value": "string"
}
],
"logicalOperators": [
"AND"
]
},
"groupBy": [
"string"
],
"latest_only": true,
"limit": 1,
"orderBy": [
{
"column": "column",
"direction": "ASC",
"source": "source"
}
]
}
}
]
}
],
"total": 0,
"limit": 0,
"object": "list"
}