Skip to contentSkip to page list

Docs

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
Request and response examples
request.py
import osimport requests​origin = "https://app.langwatch.ai"path = "/api/v1/projects/<projectId>/analytics/dashboard-widgets"api_key = os.environ["LANGWATCH_API_KEY"]headers = {    "X-Auth-Token": api_key,}​response = requests.get(    origin + path,    headers=headers,)print(response.json())

The project's dashboard widgets

application/json · Generated from schema

{  "data": [    {      "id": "string",      "name": "string",      "definition": {        "version": 0,        "code": "string",        "queries": [          {            "name": null,            "sql": null,            "parameters": null,            "sources": null,            "projects": null          }        ],        "description": "string",        "prompt": "string",        "source": {          "kind": null,          "catalogueId": null        }      },      "createdAt": "string",      "updatedAt": "string",      "platformUrl": "string",      "dashboardId": "string",      "gridColumn": -9007199254740991,      "gridRow": -9007199254740991,      "colSpan": -9007199254740991,      "rowSpan": -9007199254740991    }  ]}
api-reference/projects/list-dashboard-widgets

Authorization

X-Auth-Tokenstringheaderrequired

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

projectIdstringrequired
At least 1 character

Responses

200

The project's dashboard widgets

application/json

dataobject[]required
idstringrequired
namestringrequired
definitionobjectrequired
createdAtstringrequired
updatedAtstringrequired
platformUrlstringrequired
dashboardIdstring | nullrequired
gridColumnintegerrequired
Minimum -9007199254740991Maximum 9007199254740991
gridRowintegerrequired
Minimum -9007199254740991Maximum 9007199254740991
colSpanintegerrequired
Minimum -9007199254740991Maximum 9007199254740991
rowSpanintegerrequired
Minimum -9007199254740991Maximum 9007199254740991
400

Bad Request

application/json

typestringrequired
codestringrequired
messagestringrequired
retryablebooleanrequired
metaobject
trace_idstring
span_idstring
traceobject
traceIdstring
spanIdstring
traceUrlstring
logsUrlstring
tipsstring[]
docs_urlstring
faultstring
One of"customer""platform""provider""presumed_platform"
reasonsany[]
401

Unauthorized

application/json

typestringrequired
codestringrequired
messagestringrequired
retryablebooleanrequired
metaobject
trace_idstring
span_idstring
traceobject
traceIdstring
spanIdstring
traceUrlstring
logsUrlstring
tipsstring[]
docs_urlstring
faultstring
One of"customer""platform""provider""presumed_platform"
reasonsany[]
403

Forbidden

application/json

typestringrequired
codestringrequired
messagestringrequired
retryablebooleanrequired
metaobject
trace_idstring
span_idstring
traceobject
traceIdstring
spanIdstring
traceUrlstring
logsUrlstring
tipsstring[]
docs_urlstring
faultstring
One of"customer""platform""provider""presumed_platform"
reasonsany[]
500

Internal Server Error

application/json

typestringrequired
codestringrequired
messagestringrequired
retryablebooleanrequired
metaobject
trace_idstring
span_idstring
traceobject
traceIdstring
spanIdstring
traceUrlstring
logsUrlstring
tipsstring[]
docs_urlstring
faultstring
One of"customer""platform""provider""presumed_platform"
reasonsany[]

Documentation