Skip to main content

​
Dashboard Endpoints

Manage complete dashboard configurations with drag-and-drop layouts and component state.

​
POST /dashboards

Creates a new dashboard with the specified configuration.
# Create a new dashboard
dashboard = client.dashboards.create_dashboard(
    name="Wind Farm Dashboard",
    components=["comp_123", "comp_456"],
    react_grid_layout_config={...},
    component_state={...}
)

​
GET /dashboards

Retrieves all dashboards for the authenticated user.
# List all dashboards
dashboards = client.dashboards.list_dashboards()

​
GET /dashboards/

Retrieves a specific dashboard by ID.
# Get a specific dashboard by ID string
dashboard = client.dashboards.get_dashboard("dashboard_123")

# Or if you have a dashboard object
dashboard = client.dashboards.get_dashboard(dashboard.id)

​
PUT /dashboards/

Updates the layout and component state of an existing dashboard.
# Update dashboard components by ID string
updated_dashboard = client.dashboards.update_dashboard(
    "dashboard_123",
    components=["comp_123", "comp_456"]
)

# Or if you have a dashboard object
updated_dashboard = client.dashboards.update_dashboard(
    dashboard.id,
    components=["comp_123", "comp_456"]
)

​
DELETE /dashboards/

Permanently deletes a dashboard and all its associated data.
# Delete a dashboard by ID string
client.dashboards.delete_dashboard("dashboard_123")

# Or if you have a dashboard object
client.dashboards.delete_dashboard(dashboard.id)