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

Find dashboards

GET
/v1/private/dashboards
GET
/api/v1/private/dashboards
$curl http://localhost:5173/api/v1/private/dashboards
200Retrieved
1{
2 "content": [
3 {
4 "name": "string",
5 "config": {},
6 "id": "string",
7 "workspace_id": "string",
8 "project_id": "string",
9 "slug": "string",
10 "type": "multi_project",
11 "scope": "workspace",
12 "description": "string",
13 "created_by": "string",
14 "last_updated_by": "string",
15 "created_at": "2024-01-15T09:30:00Z",
16 "last_updated_at": "2024-01-15T09:30:00Z"
17 }
18 ],
19 "page": 1,
20 "size": 1,
21 "total": 1,
22 "sortable_by": [
23 "string"
24 ]
25}
Find dashboards in a workspace
Was this page helpful?
Previous

Create dashboard

Next
Built with

Query parameters

pageintegerOptional>=1Defaults to 1
sizeintegerOptional>=1Defaults to 10
namestringOptional
project_idstringOptionalformat: "uuid"
sortingstringOptional
filtersstringOptional

Response

Dashboard page
contentlist of objects
pageinteger
sizeinteger
totallong
sortable_bylist of strings