Patch Evaluation Dashboard

Partially update dashboard metadata (name, description, widget_order)

PATCH /v5/evaluation-dashboards/{dashboard_id}

Patch Evaluation Dashboard

cURL

curl --request PATCH \
  --url https://api.egp.scale.com/v5/evaluation-dashboards/{dashboard_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "tags": [
    "<string>"
  ],
  "name": "<string>",
  "description": "<string>",
  "widget_order": [
    "<string>"
  ]
}
'

200

{
  "id": "<string>",
  "created_by": {
    "id": "<string>",
    "object": "identity"
  },
  "tags": [
    "<string>"
  ],
  "name": "<string>",
  "account_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "object": "evaluation_dashboard",
  "description": "<string>",
  "evaluation_id": "<string>",
  "evaluation_group_id": "<string>",
  "widget_order": [
    "<string>"
  ],
  "error_message": "<string>",
  "archived_at": "2023-11-07T05:31:56Z",
  "widgets": [
    {
      "id": "<string>",
      "title": "<string>",
      "account_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "object": "evaluation_dashboard_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>"
        ]
      },
      "config": {},
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ],
  "widget_results": [
    {
      "id": "<string>",
      "widget_id": "<string>",
      "account_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "object": "evaluation_dashboard_widget_result",
      "evaluation_id": "<string>",
      "evaluation_group_id": "<string>",
      "computed_result": {},
      "error_message": "<string>",
      "computation_job_id": "<string>",
      "computed_at": "2023-11-07T05:31:56Z",
      "widget": {
        "id": "<string>",
        "title": "<string>",
        "account_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "object": "evaluation_dashboard_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>"
          ]
        },
        "config": {},
        "archived_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

tags · string[]

The tags associated with the entity

name · string

Dashboard name

Required string length: 1 - 256

description · string

Dashboard description

widget_order · string[]

Ordered array of widget IDs (for reordering widgets)

Response

200

application/json

Successful Response

id · string · required

Unique identifier of the dashboard

created_by · Identity · object · required

The identity that created the entity.

Show child attributes

tags · string[] · required

The tags associated with the entity

name · string · required

Dashboard name

account_id · string · required

Account that owns this dashboard

created_at · string<date-time> · required

When the dashboard was created

updated_at · string<date-time> · required

When the dashboard was last updated

object · string · default: evaluation_dashboard

Allowed value: "evaluation_dashboard"

description · string

Dashboard description

evaluation_id · string

Evaluation ID

evaluation_group_id · string

Evaluation group ID

widget_order · string[]

Ordered array of widget IDs

error_message · string

Error message if computation failed

archived_at · string<date-time>

When the dashboard was archived (soft-deleted)

widgets · Widgets · object[]

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

Show child attributes

widget_results · Widget Results · object[]

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

Show child attributes