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>"
]
}
'import requests
url = "https://api.egp.scale.com/v5/evaluation-dashboards/{dashboard_id}"
payload = {
"tags": ["<string>"],
"name": "<string>",
"description": "<string>",
"widget_order": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tags: ['<string>'],
name: '<string>',
description: '<string>',
widget_order: ['<string>']
})
};
fetch('https://api.egp.scale.com/v5/evaluation-dashboards/{dashboard_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.egp.scale.com/v5/evaluation-dashboards/{dashboard_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'tags' => [
'<string>'
],
'name' => '<string>',
'description' => '<string>',
'widget_order' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.egp.scale.com/v5/evaluation-dashboards/{dashboard_id}"
payload := strings.NewReader("{\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"widget_order\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.egp.scale.com/v5/evaluation-dashboards/{dashboard_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"widget_order\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.egp.scale.com/v5/evaluation-dashboards/{dashboard_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"widget_order\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"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>"
],
"latest_only": true
},
"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>"
],
"latest_only": true
},
"config": {},
"archived_at": "2023-11-07T05:31:56Z"
}
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Patch Evaluation Dashboard
Partially update a dashboard’s name, description, tags, or widget_order.
Only these mutable fields can change — the dashboard’s bound evaluation or group is
fixed at creation and cannot be reassigned here, and unset fields are left untouched
(partial-update semantics). Reorder existing widgets by sending a new widget_order,
whose entries are validated to be existing, non-duplicate widget IDs before the
update is applied; creating and attaching new widgets is done through the widget
sub-endpoints, not by editing widget_order. Archived dashboards cannot be updated
and return a not-found error.
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>"
]
}
'import requests
url = "https://api.egp.scale.com/v5/evaluation-dashboards/{dashboard_id}"
payload = {
"tags": ["<string>"],
"name": "<string>",
"description": "<string>",
"widget_order": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tags: ['<string>'],
name: '<string>',
description: '<string>',
widget_order: ['<string>']
})
};
fetch('https://api.egp.scale.com/v5/evaluation-dashboards/{dashboard_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.egp.scale.com/v5/evaluation-dashboards/{dashboard_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'tags' => [
'<string>'
],
'name' => '<string>',
'description' => '<string>',
'widget_order' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.egp.scale.com/v5/evaluation-dashboards/{dashboard_id}"
payload := strings.NewReader("{\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"widget_order\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.egp.scale.com/v5/evaluation-dashboards/{dashboard_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"widget_order\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.egp.scale.com/v5/evaluation-dashboards/{dashboard_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"widget_order\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"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>"
],
"latest_only": true
},
"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>"
],
"latest_only": true
},
"config": {},
"archived_at": "2023-11-07T05:31:56Z"
}
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Headers
Path Parameters
Body
Response
Successful Response
Unique identifier of the dashboard
The identity that created the entity.
Show child attributes
Show child attributes
The tags associated with the entity
Dashboard name
Account that owns this dashboard
When the dashboard was created
When the dashboard was last updated
"evaluation_dashboard"Dashboard description
Evaluation ID
Evaluation group ID
Ordered array of widget IDs
Error message if computation failed
When the dashboard was archived (soft-deleted)
Widgets associated with this dashboard. Populated with 'widgets' view.
Show child attributes
Show child attributes
Widget results for this dashboard. Populated with 'widget_results' view.
Show child attributes
Show child attributes

