Get dashboard by id | Opik Documentation

curl http://localhost:5173/api/v1/private/dashboards/dashboardId \
     -H "Content-Type: application/json"

{
  "name": "Q2 Marketing Dashboard",
  "config": {
    "widgets": [
      {
        "type": "chart",
        "title": "Website Traffic",
        "data_source": "google_analytics",
        "metrics": [
          "sessions",
          "users"
        ],
        "time_range": "last_30_days"
      },
      {
        "type": "table",
        "title": "Campaign ROI",
        "data_source": "ad_platform",
        "columns": [
          "campaign_name",
          "spend",
          "revenue",
          "roi"
        ]
      }
    ],
    "layout": {
      "columns": 2,
      "rows": 1
    }
  },
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workspace_id": "workspace-12345",
  "project_id": "7b9e1f2a-4d3c-4f8a-9a2e-1c2b3d4e5f6a",
  "slug": "q2-marketing-dashboard",
  "type": "multi_project",
  "scope": "workspace",
  "description": "Dashboard showing key marketing metrics and campaign performance for Q2.",
  "created_by": "alice.jones@example.com",
  "last_updated_by": "bob.smith@example.com",
  "created_at": "2024-01-15T09:30:00Z",
  "last_updated_at": "2024-01-15T09:30:00Z"
}

Get dashboard by id

Path parameters

dashboardIdstringRequiredformat: "uuid"

Response

Dashboard resource

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