Add Widget to Dashboard

curl --request POST \
  --url https://api.egp.scale.com/v5/evaluation-dashboards/{dashboard_id}/widgets \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "title": "<string>",
  "query": {
    "select": [
      {
        "expression": {
          "column": "<string>",
          "type": "COLUMN",
          "source": "<string>"
        },
        "alias": "<string>"
      }
    ],
    "groupBy": [
      "<string>"
    ],
    "orderBy": [
      {
        "column": "<string>",
        "source": "<string>",
        "direction": "ASC"
      }
    ],
    "limit": 2,
    "evaluation_ids": [
      "<string>"
    ],
    "latest_only": true
  },
  "config": {}
}
'

{
  "id": "<string>",
  "title": "<string>",
  "account_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "object": "evaluation_widget",
  "query": {
    "select": [
      {
        "expression": {
          "column": "<string>",
          "type": "COLUMN",
          "source": "<string>"
        },
        "alias": "<string>"
      }
    ],
    "filter": {
      "conditions": [
        {
          "column": "<string>",
          "source": "<string>",
          "value": "<string>"
        }
      ],
      "logicalOperators": []
    },
    "groupBy": [
      "<string>"
    ],
    "orderBy": [
      {
        "column": "<string>",
        "source": "<string>",
        "direction": "ASC"
      }
    ],
    "limit": 2,
    "evaluation_ids": [
      "<string>"
    ],
    "latest_only": true
  },
  "config": {},
  "result": {
    "id": "<string>",
    "widget_id": "<string>",
    "computation_status": "<string>",
    "computed_result": {},
    "error_message": "<string>",
    "computed_at": "2023-11-07T05:31:56Z"
  }
}

Evaluation Dashboards

Add Widget to Dashboard

Create a new widget, append it to the dashboard, and compute its result in one call.

The widget is persisted as its own entity, its ID is appended to the dashboard’s widget_order, and — unless it is a markdown or heading widget — its result is computed synchronously against the dashboard’s evaluation (or evaluation-group) data before the response returns. Validation is type-specific: markdown requires config.content, bar/histogram/donut/scatter require exactly one of config.x_column or config.x_column_group, table configs with conditional formatting are schema-validated, and all other chart types require a query. The dashboard must exist and not be archived. A computation failure does not fail the request: the widget is still created and returned with a result whose computation_status is failed and an error_message set, while markdown and heading widgets return a null result.

POST

evaluation-dashboards

{dashboard_id}

widgets

Add Widget to Dashboard

curl --request POST \
  --url https://api.egp.scale.com/v5/evaluation-dashboards/{dashboard_id}/widgets \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "title": "<string>",
  "query": {
    "select": [
      {
        "expression": {
          "column": "<string>",
          "type": "COLUMN",
          "source": "<string>"
        },
        "alias": "<string>"
      }
    ],
    "groupBy": [
      "<string>"
    ],
    "orderBy": [
      {
        "column": "<string>",
        "source": "<string>",
        "direction": "ASC"
      }
    ],
    "limit": 2,
    "evaluation_ids": [
      "<string>"
    ],
    "latest_only": true
  },
  "config": {}
}
'

{
  "id": "<string>",
  "title": "<string>",
  "account_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "object": "evaluation_widget",
  "query": {
    "select": [
      {
        "expression": {
          "column": "<string>",
          "type": "COLUMN",
          "source": "<string>"
        },
        "alias": "<string>"
      }
    ],
    "filter": {
      "conditions": [
        {
          "column": "<string>",
          "source": "<string>",
          "value": "<string>"
        }
      ],
      "logicalOperators": []
    },
    "groupBy": [
      "<string>"
    ],
    "orderBy": [
      {
        "column": "<string>",
        "source": "<string>",
        "direction": "ASC"
      }
    ],
    "limit": 2,
    "evaluation_ids": [
      "<string>"
    ],
    "latest_only": true
  },
  "config": {},
  "result": {
    "id": "<string>",
    "widget_id": "<string>",
    "computation_status": "<string>",
    "computed_result": {},
    "error_message": "<string>",
    "computed_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

x-api-key

string

header

required

Headers

x-selected-account-id

string | null

Path Parameters

dashboard_id

string

required

Body

application/json

title

string

required

Widget title

Required string length: 1 - 256

type

enum<string>

required

Widget type

Available options:

bar,

histogram,

donut,

scatter,

metric,

table,

markdown,

heading,

timeseries

query

SeriesQuery · object

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

SeriesQuery
MetricQuery

Show child attributes

config

Config · object

Chart-specific display configuration

Response

Successful Response

Response model for widget creation - includes widget and computed result

string

required

Unique identifier of the widget

title

string

required

Widget title

type

enum<string>

required

Widget type

Available options:

bar,

histogram,

donut,

scatter,

metric,

table,

markdown,

heading,

timeseries

account_id

string

required

Account that owns this widget

created_at

string<date-time>

required

When the widget was created

object

string

default:evaluation_widget

Allowed value: "evaluation_widget"

query

SeriesQuery · object

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

SeriesQuery
MetricQuery

Show child attributes

config

Config · object

Display configuration

result

EvaluationWidgetResultResponse · object

Computed result for this widget

Show child attributes

Patch Evaluation Dashboard Remove Widget from Dashboard

⌘I