Documentation

Evaluation Dashboards

EvaluationDashboardsResource

Methods

create() ->
EvaluationDashboard
post/v5/evaluation-dashboards

Create a new evaluation dashboard for an evaluation or evaluation group

list() -> SyncCursorPage[
EvaluationDashboard
]
get/v5/evaluation-dashboards

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

retrieve(, ) ->
EvaluationDashboard
get/v5/evaluation-dashboards/{dashboard_id}

Get a single evaluation dashboard by ID

update(, ) ->
EvaluationDashboard
patch/v5/evaluation-dashboards/{dashboard_id}

Partially update dashboard metadata (name, description, widget_order)

delete() ->
EvaluationDashboard
delete/v5/evaluation-dashboards/{dashboard_id}

Soft delete an evaluation dashboard

Domain types

class EvaluationDashboard: ...
Evaluation Dashboards

Widgets

EvaluationDashboardsResource.WidgetsResource

Methods

create(, ) ->
EvaluationDashboardWidgetWithResult
post/v5/evaluation-dashboards/{dashboard_id}/widgets

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

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.

delete(, )
delete/v5/evaluation-dashboards/{dashboard_id}/widgets/{widget_id}

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

Parameters
dashboard_id: str
widget_id: str
Request example

Domain types

class EvaluationDashboardWidget: ...
class EvaluationDashboardWidgetResult: ...
class EvaluationDashboardWidgetWithResult: ...

Response model for widget creation - includes widget and computed result