For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Copy to LLMGithubGo to App
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
    • Overview
  • Python SDK
    • Reference
    • REST API Client
  • Typescript SDK
    • Overview
    • Opik TS
    • Prompts
    • Opik Query Language (OQL)
  • Rest API
    • Overview
        • GETFind dashboards
        • POSTCreate dashboard
        • GETGet dashboard by id
        • DELDelete dashboard
        • PATCHUpdate dashboard
        • POSTDelete dashboards
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferenceDashboards

Update dashboard

PATCH
/v1/private/dashboards/:dashboardId
PATCH
/api/v1/private/dashboards/:dashboardId
$curl -X PATCH http://localhost:5173/api/v1/private/dashboards/dashboardId \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "name": "string",
3  "config": {},
4  "id": "string",
5  "workspace_id": "string",
6  "project_id": "string",
7  "slug": "string",
8  "type": "multi_project",
9  "scope": "workspace",
10  "description": "string",
11  "created_by": "string",
12  "last_updated_by": "string",
13  "created_at": "2024-01-15T09:30:00Z",
14  "last_updated_at": "2024-01-15T09:30:00Z"
15}

Update dashboard by id. Partial updates are supported - only provided fields will be updated.

Was this page helpful?
Previous

Delete dashboards

Next
Built with

Path parameters

dashboardIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.
namestringOptionalformat: "(?s)^\s*(\S.*\S|\S)\s*$"1-120 characters
typeenumOptional
Allowed values:
descriptionstringOptional0-1000 characters
configobjectOptional

Response

Updated dashboard
namestring1-120 characters
configobject
idstringRead-onlyformat: "uuid"
workspace_idstringRead-only
project_idstringformat: "uuid"

Project ID. Takes precedence over project_name when both are provided.

slugstringRead-only
typeenum
Allowed values:
scopeenumRead-only
Allowed values:
descriptionstring0-1000 characters
created_bystringRead-only
last_updated_bystringRead-only
created_atdatetimeRead-only
last_updated_atdatetimeRead-only

Errors

404
Not Found Error
409
Conflict Error