Skip to contentSkip to page list

Docs

Update a dashboard

Changes a dashboard's name or description; a field the body leaves out keeps its value, and a null description clears it.

PATCH/api/v1/dashboards/{dashboardId}
Request and response examples
request.py
import osimport requests​origin = "https://app.langwatch.ai"path = "/api/v1/dashboards/<dashboardId>"api_key = os.environ["LANGWATCH_API_KEY"]headers = {    "X-Auth-Token": api_key,    "Content-Type": "application/json",}payload = {}​response = requests.patch(    origin + path,    headers=headers,    json=payload,)print(response.json())

The updated dashboard

application/json · Generated from schema

{  "id": "string",  "name": "string",  "description": "string",  "scope": "PRIVATE",  "createdById": "string",  "createdAt": "string",  "updatedAt": "string",  "platformUrl": "string"}
api-reference/dashboards/update-a-dashboard

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

dashboardIdstringrequired
At least 1 character

Request body

application/json · Required

namestring
At least 1 characterUp to 255 characters
descriptionstring | null
Option 1string
Option 2null

Responses

200

The updated dashboard

application/json

idstringrequired
At least 1 character
namestringrequired
At least 1 characterUp to 255 characters
descriptionstring | nullrequired
scopestringrequired
One of"PRIVATE""PROJECT""ORGANIZATION"
createdByIdstring | nullrequired
createdAtstringrequired
updatedAtstringrequired
platformUrlstringrequired
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[]
404

No dashboard with this id for this key. A dashboard made by POST /api/v1/analytics/reports is an Analytics Report and is not found here.

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