Documentation | Evaluation Dashboards › Widgets

Evaluation Dashboards

evaluation_dashboards

Methods

Create Evaluation Dashboard ->

EvaluationDashboard

post/v5/evaluation-dashboards

Create a new evaluation dashboard for an evaluation or evaluation group

List Evaluation Dashboards -> CursorPage<

EvaluationDashboard

get/v5/evaluation-dashboards

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

Get Evaluation Dashboard ->

EvaluationDashboard

get/v5/evaluation-dashboards/{dashboard_id}

Get a single evaluation dashboard by ID

Patch Evaluation Dashboard ->

EvaluationDashboard

patch/v5/evaluation-dashboards/{dashboard_id}

Partially update dashboard metadata (name, description, widget_order)

Delete Evaluation Dashboard ->

EvaluationDashboard

delete/v5/evaluation-dashboards/{dashboard_id}

Soft delete an evaluation dashboard

Domain types

EvaluationDashboard = { id, account_id, created_at, 13 more... }

Evaluation Dashboards

Widgets

evaluation_dashboards.widgets

Methods

Add Widget To Dashboard ->

EvaluationDashboardWidgetWithResult

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

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

path Parameters

dashboard_id: string

Response fields

EvaluationDashboardWidgetWithResult

Request example

curl https://api.egp.scale.com/v5/evaluation-dashboards/$DASHBOARD_ID/widgets \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $SGP_API_KEY" \
    -d '{
          "title": "x",
          "type": "bar"
        }'

200Example

{
  "id": "id",
  "account_id": "account_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "title": "title",
  "type": "bar",
  "config": {
    "foo": "bar"
  },
  "object": "evaluation_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"
    ],
    "limit": 1,
    "orderBy": [
      {
        "column": "column",
        "direction": "ASC",
        "source": "source"
      }
    ]
  },
  "result": {
    "id": "id",
    "computation_status": "computation_status",
    "widget_id": "widget_id",
    "computed_at": "2019-12-27T18:11:19.117Z",
    "computed_result": {
      "foo": "bar"
    },
    "error_message": "error_message"
  }
}

Update Dashboard Widget ->

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.

Remove Widget From Dashboard ->

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

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

Domain types

EvaluationDashboardWidget = { id, account_id, created_at, 6 more... }

EvaluationDashboardWidgetResult = { id, account_id, computation_status, 10 more... }

EvaluationDashboardWidgetResultResponse = { id, computation_status, widget_id, 3 more... }

Computed result for a widget - used in widget creation response

EvaluationDashboardWidgetWithResult = { id, account_id, created_at, 6 more... }

Response model for widget creation - includes widget and computed result

EvaluationWidgetTypeEnum = "bar" | "histogram" | "donut" | 6 more...

Widget types for dashboard visualizations

Filter = { conditions, logicalOperators }

Filter clause with conditions connected by logical operators.

Conditions are evaluated left-to-right without precedence (no nesting/parentheses). Example: condition1 AND condition2 OR condition3 evaluates as ((condition1 AND condition2) OR condition3)

Example: { "conditions": [ {"column": "score", "operator": ">", "value": 0.5}, {"column": "category", "operator": "=", "value": "test"} ], "logicalOperators": ["AND"] }

MetricQuery = { select, evaluation_ids, filter }

Query that returns a single metric value (used for metric widgets).

Used for widget type: metric. Enforces exactly 1 aggregation in select. Returns: {"type": "metric", "data": ...}

Example SQL equivalent: SELECT AVG(score) as average_score FROM evaluation_items

SelectItem = { expression, alias }

Column in SELECT clause

SeriesQuery = { select, evaluation_ids, filter, 3 more... }

Query that returns a series of records (used for table/bar/histogram/donut/scatter widgets).

Used for widget types: table, bar, histogram, donut, scatter. Returns: {"type": "series", "data": [...]}

Example SQL equivalent: SELECT category, AVG(score) as avg_score, COUNT(*) as count FROM evaluation_items WHERE score > 0.5 AND category = 'test' GROUP BY category ORDER BY avg_score DESC LIMIT 100