Get dashboard by id | Opik Documentation

import requests
url = "http://localhost:5173/api/v1/private/dashboards/dashboardId"
payload = {}
headers = {"Content-Type": "application/json"}
response = requests.get(url, json=payload, headers=headers)
print(response.json())

{
  "name": "Marketing Analytics Dashboard",
  "config": {
    "widgets": [
      {
        "type": "line_chart",
        "title": "Monthly Leads",
        "data_source": "leads_data",
        "settings": {
          "x_axis": "month",
          "y_axis": "lead_count"
        }
      },
      {
        "type": "pie_chart",
        "title": "Campaign Distribution",
        "data_source": "campaign_data",
        "settings": {
          "category_field": "campaign_name",
          "value_field": "budget_spent"
        }
      }
    ],
    "layout": "grid"
  },
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workspace_id": "workspace-12345",
  "slug": "marketing-analytics-dashboard",
  "description": "Dashboard showing key marketing metrics including campaign performance and lead generation.",
  "created_by": "user_jane_doe",
  "last_updated_by": "user_john_smith",
  "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

idstring or nullRead-onlyformat: "uuid"

workspace_idstring or nullRead-only

slugstring or nullRead-only

descriptionstring or null0-1000 characters

created_bystring or nullRead-only

last_updated_bystring or nullRead-only

created_atdatetime or nullRead-only

last_updated_atdatetime or nullRead-only

Path parameters

Response

Errors