Get a dashboard with its latest widget data
curl --request GET \
--url https://api.neoagent.io/public-api/dashboards/{dashboard_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.neoagent.io/public-api/dashboards/{dashboard_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.neoagent.io/public-api/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.neoagent.io/public-api/dashboards/{dashboard_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.neoagent.io/public-api/dashboards/{dashboard_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.neoagent.io/public-api/dashboards/{dashboard_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.neoagent.io/public-api/dashboards/{dashboard_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"dashboard": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"definition_id": "<string>",
"id": "<string>",
"name": "<string>",
"period_rule": {
"kind": "LAST_N_DAYS",
"timezone": "<string>",
"days": 183
},
"permission_groups": {},
"updated_at": "2023-11-07T05:31:56Z"
},
"module": "<string>",
"pending_widget_ids": [
"<string>"
],
"preview": true,
"widgets": [
{
"data": {},
"error": "<string>",
"error_at": "2023-11-07T05:31:56Z",
"error_kind": "PERMISSION",
"pending": true,
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"refreshed_at": "2023-11-07T05:31:56Z",
"stale": true,
"widget": {
"component": "stat_group",
"id": "<string>",
"layout": {
"h": 6,
"w": 6,
"x": 1,
"y": 1
},
"title": "<string>",
"data_schema": {},
"inputs": [
"<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
Get a dashboard with its latest widget data
The dashboard, its Python module, and each widget with its stored data, the period that data covers, refreshed_at, and the newest error: error is its full text (the route called, the status, the reason, the module line), for fixing the widget; error_kind is what the page tells a person: PERMISSION (a read refused for a permission group the dashboard lacks; add it to permission_groups with PUT), VENDOR, TIMEOUT, CODE, INVALID_DATA, INPUT_FAILED (an input widget failed), CREDITS or SANDBOX. Reads only: never starts a refresh. A widget is stale when its data is older than 15 minutes, never produced, or from an earlier definition; pending when a refresh was asked for after its last write (data or error): the current refresh run, or the next one to start, has it to do; also listed in pending_widget_ids. A widget nobody has asked to refresh is not pending. ?preview=true caps each widget’s data to its first rows and ~1 KB, for a model’s context; without it data is complete (up to 512 KB per widget). To refresh, call POST /dashboards/<id>/refresh. 404 dashboard_not_found for another workspace’s dashboard or a deleted one.
GET
/
public-api
/
dashboards
/
{dashboard_id}
Get a dashboard with its latest widget data
curl --request GET \
--url https://api.neoagent.io/public-api/dashboards/{dashboard_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.neoagent.io/public-api/dashboards/{dashboard_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.neoagent.io/public-api/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.neoagent.io/public-api/dashboards/{dashboard_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.neoagent.io/public-api/dashboards/{dashboard_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.neoagent.io/public-api/dashboards/{dashboard_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.neoagent.io/public-api/dashboards/{dashboard_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"dashboard": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"definition_id": "<string>",
"id": "<string>",
"name": "<string>",
"period_rule": {
"kind": "LAST_N_DAYS",
"timezone": "<string>",
"days": 183
},
"permission_groups": {},
"updated_at": "2023-11-07T05:31:56Z"
},
"module": "<string>",
"pending_widget_ids": [
"<string>"
],
"preview": true,
"widgets": [
{
"data": {},
"error": "<string>",
"error_at": "2023-11-07T05:31:56Z",
"error_kind": "PERMISSION",
"pending": true,
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"refreshed_at": "2023-11-07T05:31:56Z",
"stale": true,
"widget": {
"component": "stat_group",
"id": "<string>",
"layout": {
"h": 6,
"w": 6,
"x": 1,
"y": 1
},
"title": "<string>",
"data_schema": {},
"inputs": [
"<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).
Path Parameters
Query Parameters
true for capped widget data.