List dashboard widgets
import requests
url = "https://app.langwatch.ai/api/v1/projects/{projectId}/analytics/dashboard-widgets"
headers = {"X-Auth-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>'}};
fetch('https://app.langwatch.ai/api/v1/projects/{projectId}/analytics/dashboard-widgets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://app.langwatch.ai/api/v1/projects/{projectId}/analytics/dashboard-widgets \
--header 'X-Auth-Token: <api-key>'{
"data": [
{
"id": "<string>",
"name": "<string>",
"definition": {
"version": 123,
"code": "<string>",
"queries": [
{
"name": "<string>",
"sql": "<string>",
"parameters": [
{
"name": "<string>",
"type": "string",
"default": "<string>"
}
]
}
],
"description": "<string>",
"prompt": "<string>",
"source": {
"kind": "catalogue",
"catalogueId": "<string>"
}
},
"createdAt": "<string>",
"updatedAt": "<string>",
"platformUrl": "<string>",
"dashboardId": "<string>",
"gridColumn": 0,
"gridRow": 0,
"colSpan": 0,
"rowSpan": 0
}
]
}{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"meta": {},
"trace_id": "<string>",
"span_id": "<string>",
"trace": {
"traceId": "<string>",
"spanId": "<string>",
"traceUrl": "<string>",
"logsUrl": "<string>"
},
"tips": [
"<string>"
],
"docs_url": "<string>",
"fault": "customer",
"reasons": [
"<unknown>"
]
}{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"meta": {},
"trace_id": "<string>",
"span_id": "<string>",
"trace": {
"traceId": "<string>",
"spanId": "<string>",
"traceUrl": "<string>",
"logsUrl": "<string>"
},
"tips": [
"<string>"
],
"docs_url": "<string>",
"fault": "customer",
"reasons": [
"<unknown>"
]
}{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"meta": {},
"trace_id": "<string>",
"span_id": "<string>",
"trace": {
"traceId": "<string>",
"spanId": "<string>",
"traceUrl": "<string>",
"logsUrl": "<string>"
},
"tips": [
"<string>"
],
"docs_url": "<string>",
"fault": "customer",
"reasons": [
"<unknown>"
]
}{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"meta": {},
"trace_id": "<string>",
"span_id": "<string>",
"trace": {
"traceId": "<string>",
"spanId": "<string>",
"traceUrl": "<string>",
"logsUrl": "<string>"
},
"tips": [
"<string>"
],
"docs_url": "<string>",
"fault": "customer",
"reasons": [
"<unknown>"
]
}Projects
List dashboard widgets
Lists every dashboard widget in this project, each with the React source file it renders and the named LangWatchQL queries it may run. Saved workbench charts and builder charts are different kinds and are not listed here.
GET
/
api
/
v1
/
projects
/
{projectId}
/
analytics
/
dashboard-widgets
List dashboard widgets
import requests
url = "https://app.langwatch.ai/api/v1/projects/{projectId}/analytics/dashboard-widgets"
headers = {"X-Auth-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>'}};
fetch('https://app.langwatch.ai/api/v1/projects/{projectId}/analytics/dashboard-widgets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://app.langwatch.ai/api/v1/projects/{projectId}/analytics/dashboard-widgets \
--header 'X-Auth-Token: <api-key>'{
"data": [
{
"id": "<string>",
"name": "<string>",
"definition": {
"version": 123,
"code": "<string>",
"queries": [
{
"name": "<string>",
"sql": "<string>",
"parameters": [
{
"name": "<string>",
"type": "string",
"default": "<string>"
}
]
}
],
"description": "<string>",
"prompt": "<string>",
"source": {
"kind": "catalogue",
"catalogueId": "<string>"
}
},
"createdAt": "<string>",
"updatedAt": "<string>",
"platformUrl": "<string>",
"dashboardId": "<string>",
"gridColumn": 0,
"gridRow": 0,
"colSpan": 0,
"rowSpan": 0
}
]
}{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"meta": {},
"trace_id": "<string>",
"span_id": "<string>",
"trace": {
"traceId": "<string>",
"spanId": "<string>",
"traceUrl": "<string>",
"logsUrl": "<string>"
},
"tips": [
"<string>"
],
"docs_url": "<string>",
"fault": "customer",
"reasons": [
"<unknown>"
]
}{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"meta": {},
"trace_id": "<string>",
"span_id": "<string>",
"trace": {
"traceId": "<string>",
"spanId": "<string>",
"traceUrl": "<string>",
"logsUrl": "<string>"
},
"tips": [
"<string>"
],
"docs_url": "<string>",
"fault": "customer",
"reasons": [
"<unknown>"
]
}{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"meta": {},
"trace_id": "<string>",
"span_id": "<string>",
"trace": {
"traceId": "<string>",
"spanId": "<string>",
"traceUrl": "<string>",
"logsUrl": "<string>"
},
"tips": [
"<string>"
],
"docs_url": "<string>",
"fault": "customer",
"reasons": [
"<unknown>"
]
}{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"meta": {},
"trace_id": "<string>",
"span_id": "<string>",
"trace": {
"traceId": "<string>",
"spanId": "<string>",
"traceUrl": "<string>",
"logsUrl": "<string>"
},
"tips": [
"<string>"
],
"docs_url": "<string>",
"fault": "customer",
"reasons": [
"<unknown>"
]
}Authorizations
Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.
Path Parameters
Minimum string length:
1Response
The project's dashboard widgets
Show child attributes
Show child attributes
Last modified on October 27, 2026
Was this page helpful?