dashboards
Create dashboards widgets
Requires scopes: reports:write
POST
/
api
/
dashboards
/
{id}
/
widgets
Create dashboards widgets
curl --request POST \
--url https://evalgate.com/api/dashboards/{id}/widgets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "table",
"name": "<string>",
"refreshPolicy": {
"mode": "manual",
"intervalSeconds": 123
},
"widgetKey": "<string>",
"metricDefinitionId": "<string>",
"position": {
"x": 123,
"y": 123,
"w": 123,
"h": 123
},
"drilldown": {
"target": "evaluation",
"pathTemplate": "<string>",
"preserveFilters": false
},
"visualizationConfig": {}
}
'import requests
url = "https://evalgate.com/api/dashboards/{id}/widgets"
payload = {
"type": "table",
"name": "<string>",
"refreshPolicy": {
"mode": "manual",
"intervalSeconds": 123
},
"widgetKey": "<string>",
"metricDefinitionId": "<string>",
"position": {
"x": 123,
"y": 123,
"w": 123,
"h": 123
},
"drilldown": {
"target": "evaluation",
"pathTemplate": "<string>",
"preserveFilters": False
},
"visualizationConfig": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'table',
name: '<string>',
refreshPolicy: {mode: 'manual', intervalSeconds: 123},
widgetKey: '<string>',
metricDefinitionId: '<string>',
position: {x: 123, y: 123, w: 123, h: 123},
drilldown: {target: 'evaluation', pathTemplate: '<string>', preserveFilters: false},
visualizationConfig: {}
})
};
fetch('https://evalgate.com/api/dashboards/{id}/widgets', 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://evalgate.com/api/dashboards/{id}/widgets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'table',
'name' => '<string>',
'refreshPolicy' => [
'mode' => 'manual',
'intervalSeconds' => 123
],
'widgetKey' => '<string>',
'metricDefinitionId' => '<string>',
'position' => [
'x' => 123,
'y' => 123,
'w' => 123,
'h' => 123
],
'drilldown' => [
'target' => 'evaluation',
'pathTemplate' => '<string>',
'preserveFilters' => false
],
'visualizationConfig' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://evalgate.com/api/dashboards/{id}/widgets"
payload := strings.NewReader("{\n \"type\": \"table\",\n \"name\": \"<string>\",\n \"refreshPolicy\": {\n \"mode\": \"manual\",\n \"intervalSeconds\": 123\n },\n \"widgetKey\": \"<string>\",\n \"metricDefinitionId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123\n },\n \"drilldown\": {\n \"target\": \"evaluation\",\n \"pathTemplate\": \"<string>\",\n \"preserveFilters\": false\n },\n \"visualizationConfig\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://evalgate.com/api/dashboards/{id}/widgets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"table\",\n \"name\": \"<string>\",\n \"refreshPolicy\": {\n \"mode\": \"manual\",\n \"intervalSeconds\": 123\n },\n \"widgetKey\": \"<string>\",\n \"metricDefinitionId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123\n },\n \"drilldown\": {\n \"target\": \"evaluation\",\n \"pathTemplate\": \"<string>\",\n \"preserveFilters\": false\n },\n \"visualizationConfig\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://evalgate.com/api/dashboards/{id}/widgets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"table\",\n \"name\": \"<string>\",\n \"refreshPolicy\": {\n \"mode\": \"manual\",\n \"intervalSeconds\": 123\n },\n \"widgetKey\": \"<string>\",\n \"metricDefinitionId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123\n },\n \"drilldown\": {\n \"target\": \"evaluation\",\n \"pathTemplate\": \"<string>\",\n \"preserveFilters\": false\n },\n \"visualizationConfig\": {}\n}"
response = http.request(request)
puts response.read_body{
"version": {
"status": "<string>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdBy": "<string>",
"version": 123,
"contentHash": "<string>",
"parentVersionId": "<string>",
"dashboardId": "<string>",
"layout": {
"columns": 12,
"compact": true
},
"globalFilters": [
{
"operator": "exists",
"field": "<string>",
"value": true
}
],
"refreshPolicy": {
"mode": "manual",
"intervalSeconds": 123
},
"publishedBy": "<string>",
"publishedAt": "2023-11-07T05:31:56Z"
},
"snapshot": {
"layout": {
"columns": 12,
"compact": true
},
"globalFilters": [
{
"operator": "exists",
"field": "<string>",
"value": true
}
],
"refreshPolicy": {
"mode": "manual",
"intervalSeconds": 123
},
"widgets": [
{
"type": "table",
"name": "<string>",
"refreshPolicy": {
"mode": "manual",
"intervalSeconds": 123
},
"widgetKey": "<string>",
"metricDefinitionId": "<string>",
"visualizationConfig": {},
"position": {
"x": 123,
"y": 123,
"w": 123,
"h": 123
},
"drilldown": {
"target": "evaluation",
"pathTemplate": "<string>",
"preserveFilters": true
}
}
]
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}Authorizations
Organization-scoped EvalGate API key. Discover the supported agent scopes at /.well-known/oauth-protected-resource. Per-operation grants are listed in x-evalgate-required-scopes; OpenAPI bearer security requirement arrays remain empty as required for non-OAuth schemes.
Path Parameters
Body
application/json
type
Option 1 · enum<string>Option 2 · enum<string>Option 3 · enum<string>Option 4 · enum<string>Option 5 · enum<string>Option 6 · enum<string>Option 7 · enum<string>Option 8 · enum<string>Option 9 · enum<string>Option 10 · enum<string>Option 11 · enum<string>Option 12 · enum<string>Option 13 · enum<string>
required
Available options:
table Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Create dashboards widgets
curl --request POST \
--url https://evalgate.com/api/dashboards/{id}/widgets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "table",
"name": "<string>",
"refreshPolicy": {
"mode": "manual",
"intervalSeconds": 123
},
"widgetKey": "<string>",
"metricDefinitionId": "<string>",
"position": {
"x": 123,
"y": 123,
"w": 123,
"h": 123
},
"drilldown": {
"target": "evaluation",
"pathTemplate": "<string>",
"preserveFilters": false
},
"visualizationConfig": {}
}
'import requests
url = "https://evalgate.com/api/dashboards/{id}/widgets"
payload = {
"type": "table",
"name": "<string>",
"refreshPolicy": {
"mode": "manual",
"intervalSeconds": 123
},
"widgetKey": "<string>",
"metricDefinitionId": "<string>",
"position": {
"x": 123,
"y": 123,
"w": 123,
"h": 123
},
"drilldown": {
"target": "evaluation",
"pathTemplate": "<string>",
"preserveFilters": False
},
"visualizationConfig": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'table',
name: '<string>',
refreshPolicy: {mode: 'manual', intervalSeconds: 123},
widgetKey: '<string>',
metricDefinitionId: '<string>',
position: {x: 123, y: 123, w: 123, h: 123},
drilldown: {target: 'evaluation', pathTemplate: '<string>', preserveFilters: false},
visualizationConfig: {}
})
};
fetch('https://evalgate.com/api/dashboards/{id}/widgets', 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://evalgate.com/api/dashboards/{id}/widgets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'table',
'name' => '<string>',
'refreshPolicy' => [
'mode' => 'manual',
'intervalSeconds' => 123
],
'widgetKey' => '<string>',
'metricDefinitionId' => '<string>',
'position' => [
'x' => 123,
'y' => 123,
'w' => 123,
'h' => 123
],
'drilldown' => [
'target' => 'evaluation',
'pathTemplate' => '<string>',
'preserveFilters' => false
],
'visualizationConfig' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://evalgate.com/api/dashboards/{id}/widgets"
payload := strings.NewReader("{\n \"type\": \"table\",\n \"name\": \"<string>\",\n \"refreshPolicy\": {\n \"mode\": \"manual\",\n \"intervalSeconds\": 123\n },\n \"widgetKey\": \"<string>\",\n \"metricDefinitionId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123\n },\n \"drilldown\": {\n \"target\": \"evaluation\",\n \"pathTemplate\": \"<string>\",\n \"preserveFilters\": false\n },\n \"visualizationConfig\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://evalgate.com/api/dashboards/{id}/widgets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"table\",\n \"name\": \"<string>\",\n \"refreshPolicy\": {\n \"mode\": \"manual\",\n \"intervalSeconds\": 123\n },\n \"widgetKey\": \"<string>\",\n \"metricDefinitionId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123\n },\n \"drilldown\": {\n \"target\": \"evaluation\",\n \"pathTemplate\": \"<string>\",\n \"preserveFilters\": false\n },\n \"visualizationConfig\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://evalgate.com/api/dashboards/{id}/widgets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"table\",\n \"name\": \"<string>\",\n \"refreshPolicy\": {\n \"mode\": \"manual\",\n \"intervalSeconds\": 123\n },\n \"widgetKey\": \"<string>\",\n \"metricDefinitionId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123\n },\n \"drilldown\": {\n \"target\": \"evaluation\",\n \"pathTemplate\": \"<string>\",\n \"preserveFilters\": false\n },\n \"visualizationConfig\": {}\n}"
response = http.request(request)
puts response.read_body{
"version": {
"status": "<string>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdBy": "<string>",
"version": 123,
"contentHash": "<string>",
"parentVersionId": "<string>",
"dashboardId": "<string>",
"layout": {
"columns": 12,
"compact": true
},
"globalFilters": [
{
"operator": "exists",
"field": "<string>",
"value": true
}
],
"refreshPolicy": {
"mode": "manual",
"intervalSeconds": 123
},
"publishedBy": "<string>",
"publishedAt": "2023-11-07T05:31:56Z"
},
"snapshot": {
"layout": {
"columns": 12,
"compact": true
},
"globalFilters": [
{
"operator": "exists",
"field": "<string>",
"value": true
}
],
"refreshPolicy": {
"mode": "manual",
"intervalSeconds": 123
},
"widgets": [
{
"type": "table",
"name": "<string>",
"refreshPolicy": {
"mode": "manual",
"intervalSeconds": 123
},
"widgetKey": "<string>",
"metricDefinitionId": "<string>",
"visualizationConfig": {},
"position": {
"x": 123,
"y": 123,
"w": 123,
"h": 123
},
"drilldown": {
"target": "evaluation",
"pathTemplate": "<string>",
"preserveFilters": true
}
}
]
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}