Dashboards

Dashboard Management API

Retrieve dashboards, access panel configurations, and generate shareable URLs for process mining insights and visualization management.

Features

Dashboard Retrieval

List and retrieve dashboards with comprehensive metadata and panel counts.

View Dashboards

Panel Information

Access dashboard panel configurations including layout and visualization settings.

View Panels

Sharing & URLs

Generate shareable links and embed URLs for dashboard access.

Share Dashboards

Available Endpoints

Connectivity Testing

  • GET /api/{tenantId}/{projectId}/dashboard/unauthorized-ping - Public connectivity test (no auth required)
  • GET /api/{tenantId}/{projectId}/dashboard/ping - Authenticated connectivity test

Dashboard Operations

Core operations for accessing dashboard resources.

  • GET /api/{tenantId}/{projectId}/dashboard - List all dashboards in a project
  • GET /api/{tenantId}/{projectId}/dashboard/{dashboardId} - Get specific dashboard details

Panel Operations

Access visualization panels within dashboards.

  • GET /api/{tenantId}/{projectId}/dashboard/{dashboardId}/panels - Get all panels in a dashboard

URL Operations

Generate shareable URLs and embed codes.

  • GET /api/{tenantId}/{projectId}/dashboard/{dashboardId}/url - Get shareable dashboard URLs

Creating Dashboards

Dashboards are created within investigations through the mindzieStudio UI. Dashboard creation requires investigation context and notebook relationships that are managed through the application:

  1. Create an investigation via the Investigation API or UI
  2. Add dashboard blocks to notebooks within that investigation
  3. Dashboards become accessible via this API

Dashboard Components

mindzieStudio dashboards provide powerful visualization capabilities:

Process Mining Visualizations

Charts and graphs for process analysis and discovery.

  • Process maps and flowcharts
  • Performance metrics charts
  • Timeline visualizations

KPI Dashboards

Key performance indicators and business metrics.

  • Real-time KPI widgets
  • Trend analysis charts
  • Comparison dashboards

Interactive Panels

Configurable panels with drag-and-drop positioning.

  • Flexible layout management
  • Responsive panel sizing
  • Custom panel configurations

Common Use Cases

  • Executive Dashboards: Access high-level KPI dashboards for management reporting
  • Operational Monitoring: View real-time dashboards for process monitoring
  • Embedded Insights: Integrate dashboard panels into external applications
  • Stakeholder Sharing: Generate shareable URLs for collaborative analysis

Authentication

All Dashboard API endpoints (except unauthorized-ping) require valid authentication with appropriate permissions for the target project and tenant.

Get Started

Begin with Dashboard Management to learn how to list and retrieve dashboards, then explore Sharing for URL generation.