Skip to main content
Opik Documentation

Search documentation

Type to search this documentation.

Find dashboards by project

GET/v1/private/projects/{projectId}/dashboardsFind dashboards by project

Find dashboards scoped to a project

Parameters

projectIdstring · uuidpathrequired
pageinteger · int32query

default 1 · minimum 1

sizeinteger · int32query

default 10 · minimum 1

namestringquery

Filter dashboards by name (partial match, case insensitive)

sortingstringquery
filtersstringquery

Responses

200Dashboard pageapplication/json
objectDashboardPage_Public
contentarray of object
Show child attributes
Show array items
configobjectrequired
created_atstring · date-time
created_bystring
descriptionstring

maxLength 1000 · minLength 0

idstring · uuid
last_updated_atstring · date-time
last_updated_bystring
namestringrequired

maxLength 120 · minLength 1

project_idstring · uuid

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

scopestring

one of "workspace", "insights"

slugstring
typestring

one of "multi_project", "experiments"

workspace_idstring
pageinteger · int32
sizeinteger · int32
sortable_byarray of string
Show child attributes
totalinteger · int64
Example response
{
  "content": [
    {
      "config": {},
      "created_at": "2026-06-09T00:00:00Z",
      "created_by": "string",
      "description": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "last_updated_at": "2026-06-09T00:00:00Z",
      "last_updated_by": "string",
      "name": "string",
      "project_id": "00000000-0000-0000-0000-000000000000",
      "scope": "insights",
      "slug": "string",
      "type": "experiments",
      "workspace_id": "string"
    }
  ],
  "page": 0,
  "size": 0,
  "sortable_by": [
    "string"
  ],
  "total": 0
}
Documentation menu