Edit one widget's code
curl --request PUT \
--url https://api.neoagent.io/public-api/dashboards/{dashboard_id}/widgets/{widget_id}/code \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"function": "<string>",
"html": "<string>",
"query": {
"columns": [
"<string>"
],
"filter": [
{
"column": "<string>",
"value": null
}
],
"group_by": [
{
"column": "<string>"
}
],
"history": {
"last": 123,
"bucket": "day"
},
"limit": 1000,
"measure": [
{
"column": "<string>",
"label": "<string>",
"where": [
{
"column": "<string>",
"value": null
}
]
}
],
"sort": {
"by": "<string>",
"dir": "desc"
}
}
}
'import requests
url = "https://api.neoagent.io/public-api/dashboards/{dashboard_id}/widgets/{widget_id}/code"
payload = {
"definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"function": "<string>",
"html": "<string>",
"query": {
"columns": ["<string>"],
"filter": [
{
"column": "<string>",
"value": None
}
],
"group_by": [{ "column": "<string>" }],
"history": {
"last": 123,
"bucket": "day"
},
"limit": 1000,
"measure": [
{
"column": "<string>",
"label": "<string>",
"where": [
{
"column": "<string>",
"value": None
}
]
}
],
"sort": {
"by": "<string>",
"dir": "desc"
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
definition_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
function: '<string>',
html: '<string>',
query: {
columns: ['<string>'],
filter: [{column: '<string>', value: null}],
group_by: [{column: '<string>'}],
history: {last: 123, bucket: 'day'},
limit: 1000,
measure: [
{
column: '<string>',
label: '<string>',
where: [{column: '<string>', value: null}]
}
],
sort: {by: '<string>', dir: 'desc'}
}
})
};
fetch('https://api.neoagent.io/public-api/dashboards/{dashboard_id}/widgets/{widget_id}/code', 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.neoagent.io/public-api/dashboards/{dashboard_id}/widgets/{widget_id}/code",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'definition_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'function' => '<string>',
'html' => '<string>',
'query' => [
'columns' => [
'<string>'
],
'filter' => [
[
'column' => '<string>',
'value' => null
]
],
'group_by' => [
[
'column' => '<string>'
]
],
'history' => [
'last' => 123,
'bucket' => 'day'
],
'limit' => 1000,
'measure' => [
[
'column' => '<string>',
'label' => '<string>',
'where' => [
[
'column' => '<string>',
'value' => null
]
]
]
],
'sort' => [
'by' => '<string>',
'dir' => 'desc'
]
]
]),
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://api.neoagent.io/public-api/dashboards/{dashboard_id}/widgets/{widget_id}/code"
payload := strings.NewReader("{\n \"definition_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"function\": \"<string>\",\n \"html\": \"<string>\",\n \"query\": {\n \"columns\": [\n \"<string>\"\n ],\n \"filter\": [\n {\n \"column\": \"<string>\",\n \"value\": null\n }\n ],\n \"group_by\": [\n {\n \"column\": \"<string>\"\n }\n ],\n \"history\": {\n \"last\": 123,\n \"bucket\": \"day\"\n },\n \"limit\": 1000,\n \"measure\": [\n {\n \"column\": \"<string>\",\n \"label\": \"<string>\",\n \"where\": [\n {\n \"column\": \"<string>\",\n \"value\": null\n }\n ]\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"dir\": \"desc\"\n }\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.neoagent.io/public-api/dashboards/{dashboard_id}/widgets/{widget_id}/code")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"definition_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"function\": \"<string>\",\n \"html\": \"<string>\",\n \"query\": {\n \"columns\": [\n \"<string>\"\n ],\n \"filter\": [\n {\n \"column\": \"<string>\",\n \"value\": null\n }\n ],\n \"group_by\": [\n {\n \"column\": \"<string>\"\n }\n ],\n \"history\": {\n \"last\": 123,\n \"bucket\": \"day\"\n },\n \"limit\": 1000,\n \"measure\": [\n {\n \"column\": \"<string>\",\n \"label\": \"<string>\",\n \"where\": [\n {\n \"column\": \"<string>\",\n \"value\": null\n }\n ]\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"dir\": \"desc\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.neoagent.io/public-api/dashboards/{dashboard_id}/widgets/{widget_id}/code")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"definition_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"function\": \"<string>\",\n \"html\": \"<string>\",\n \"query\": {\n \"columns\": [\n \"<string>\"\n ],\n \"filter\": [\n {\n \"column\": \"<string>\",\n \"value\": null\n }\n ],\n \"group_by\": [\n {\n \"column\": \"<string>\"\n }\n ],\n \"history\": {\n \"last\": 123,\n \"bucket\": \"day\"\n },\n \"limit\": 1000,\n \"measure\": [\n {\n \"column\": \"<string>\",\n \"label\": \"<string>\",\n \"where\": [\n {\n \"column\": \"<string>\",\n \"value\": null\n }\n ]\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"dir\": \"desc\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"dashboard_id": "<string>",
"definition_id": "<string>",
"name": "<string>",
"refresh_started": true,
"widget_count": 123,
"widget_ids": [
"<string>"
]
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timings_ms": {},
"pagination": {
"has_more": true,
"next_cursor": "<string>"
},
"warnings": [
"<string>"
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Dashboards
Edit one widget's code
An admin’s hand edit of one widget’s own code, what Edit in the page’s View code saves: a function widget’s whole def widget_<id>(ctx): (function, nothing else: shared helpers and collect(ctx) change through PUT /dashboards/<id>), a described widget’s query, an html widget’s html. Stored as a new definition under the checks a PUT makes (422 validation_error with details.errors, every problem); the widget then carries hand_edited_at and hand_edited_by until its code changes another way. A query or html edit keeps the stored rows (refresh_started null); a function edit refreshes the dashboard. 409 dashboard_update_conflict when definition_id is no longer the one in use or the widget is gone (details.definition_id: read it again); 403 unless an admin.
PUT
/
public-api
/
dashboards
/
{dashboard_id}
/
widgets
/
{widget_id}
/
code
Edit one widget's code
curl --request PUT \
--url https://api.neoagent.io/public-api/dashboards/{dashboard_id}/widgets/{widget_id}/code \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"function": "<string>",
"html": "<string>",
"query": {
"columns": [
"<string>"
],
"filter": [
{
"column": "<string>",
"value": null
}
],
"group_by": [
{
"column": "<string>"
}
],
"history": {
"last": 123,
"bucket": "day"
},
"limit": 1000,
"measure": [
{
"column": "<string>",
"label": "<string>",
"where": [
{
"column": "<string>",
"value": null
}
]
}
],
"sort": {
"by": "<string>",
"dir": "desc"
}
}
}
'import requests
url = "https://api.neoagent.io/public-api/dashboards/{dashboard_id}/widgets/{widget_id}/code"
payload = {
"definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"function": "<string>",
"html": "<string>",
"query": {
"columns": ["<string>"],
"filter": [
{
"column": "<string>",
"value": None
}
],
"group_by": [{ "column": "<string>" }],
"history": {
"last": 123,
"bucket": "day"
},
"limit": 1000,
"measure": [
{
"column": "<string>",
"label": "<string>",
"where": [
{
"column": "<string>",
"value": None
}
]
}
],
"sort": {
"by": "<string>",
"dir": "desc"
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
definition_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
function: '<string>',
html: '<string>',
query: {
columns: ['<string>'],
filter: [{column: '<string>', value: null}],
group_by: [{column: '<string>'}],
history: {last: 123, bucket: 'day'},
limit: 1000,
measure: [
{
column: '<string>',
label: '<string>',
where: [{column: '<string>', value: null}]
}
],
sort: {by: '<string>', dir: 'desc'}
}
})
};
fetch('https://api.neoagent.io/public-api/dashboards/{dashboard_id}/widgets/{widget_id}/code', 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.neoagent.io/public-api/dashboards/{dashboard_id}/widgets/{widget_id}/code",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'definition_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'function' => '<string>',
'html' => '<string>',
'query' => [
'columns' => [
'<string>'
],
'filter' => [
[
'column' => '<string>',
'value' => null
]
],
'group_by' => [
[
'column' => '<string>'
]
],
'history' => [
'last' => 123,
'bucket' => 'day'
],
'limit' => 1000,
'measure' => [
[
'column' => '<string>',
'label' => '<string>',
'where' => [
[
'column' => '<string>',
'value' => null
]
]
]
],
'sort' => [
'by' => '<string>',
'dir' => 'desc'
]
]
]),
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://api.neoagent.io/public-api/dashboards/{dashboard_id}/widgets/{widget_id}/code"
payload := strings.NewReader("{\n \"definition_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"function\": \"<string>\",\n \"html\": \"<string>\",\n \"query\": {\n \"columns\": [\n \"<string>\"\n ],\n \"filter\": [\n {\n \"column\": \"<string>\",\n \"value\": null\n }\n ],\n \"group_by\": [\n {\n \"column\": \"<string>\"\n }\n ],\n \"history\": {\n \"last\": 123,\n \"bucket\": \"day\"\n },\n \"limit\": 1000,\n \"measure\": [\n {\n \"column\": \"<string>\",\n \"label\": \"<string>\",\n \"where\": [\n {\n \"column\": \"<string>\",\n \"value\": null\n }\n ]\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"dir\": \"desc\"\n }\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.neoagent.io/public-api/dashboards/{dashboard_id}/widgets/{widget_id}/code")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"definition_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"function\": \"<string>\",\n \"html\": \"<string>\",\n \"query\": {\n \"columns\": [\n \"<string>\"\n ],\n \"filter\": [\n {\n \"column\": \"<string>\",\n \"value\": null\n }\n ],\n \"group_by\": [\n {\n \"column\": \"<string>\"\n }\n ],\n \"history\": {\n \"last\": 123,\n \"bucket\": \"day\"\n },\n \"limit\": 1000,\n \"measure\": [\n {\n \"column\": \"<string>\",\n \"label\": \"<string>\",\n \"where\": [\n {\n \"column\": \"<string>\",\n \"value\": null\n }\n ]\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"dir\": \"desc\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.neoagent.io/public-api/dashboards/{dashboard_id}/widgets/{widget_id}/code")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"definition_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"function\": \"<string>\",\n \"html\": \"<string>\",\n \"query\": {\n \"columns\": [\n \"<string>\"\n ],\n \"filter\": [\n {\n \"column\": \"<string>\",\n \"value\": null\n }\n ],\n \"group_by\": [\n {\n \"column\": \"<string>\"\n }\n ],\n \"history\": {\n \"last\": 123,\n \"bucket\": \"day\"\n },\n \"limit\": 1000,\n \"measure\": [\n {\n \"column\": \"<string>\",\n \"label\": \"<string>\",\n \"where\": [\n {\n \"column\": \"<string>\",\n \"value\": null\n }\n ]\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"dir\": \"desc\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"dashboard_id": "<string>",
"definition_id": "<string>",
"name": "<string>",
"refresh_started": true,
"widget_count": 123,
"widget_ids": [
"<string>"
]
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timings_ms": {},
"pagination": {
"has_more": true,
"next_cursor": "<string>"
},
"warnings": [
"<string>"
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Authorizations
Authorization: Bearer <token> where <token> is either a neo_sk_<env>_<secret> API key (service account) or a Microsoft Entra ID access token (dashboard user).
Body
application/json
A hand edit of one widget's code: the field of its kind, one or more.
The definition the edit was made on (definition_id of the dashboard as read): a 409 when it is no longer the one in use.
A function widget: its whole def widget_<id>(ctx):, decorators included, nothing else. Shared helpers and collect(ctx) are changed through a full PUT.
Maximum string length:
200000An html widget: its new html, under the same rules as on a PUT.
Maximum string length:
64000A described widget: its new query, checked against the dataset's columns.
Show child attributes
Show child attributes