Dashboard and summaries
Read dashboard metrics, MTTR, open/overdue work orders, grouped metrics, and summary views. These are read-only views for analytics and reporting. Set tenant context before calling these methods.
Dashboard metrics
Get the main dashboard metrics and MTTR metrics for the current tenant.
client.dashboard.getMetrics() and getMttrMetrics()
await client.setTenant(tenantId)
const metrics = await client.dashboard.getMetrics()
// DashboardMetricsRow[]
const mttr = await client.dashboard.getMttrMetrics()
// DashboardMttrMetricsRow[]
Open and overdue work orders
List open and overdue work orders as seen on the dashboard.
client.dashboard.listOpenWorkOrders() / listOverdueWorkOrders()
const open = await client.dashboard.listOpenWorkOrders()
// DashboardOpenWorkOrdersRow[]
const overdue = await client.dashboard.listOverdueWorkOrders()
// DashboardOverdueWorkOrdersRow[]
Work orders by status and maintenance type
Get aggregated counts by status and by maintenance type.
client.dashboard.listWorkOrdersByStatus() / listWorkOrdersByMaintenanceType()
const byStatus = await client.dashboard.listWorkOrdersByStatus()
// DashboardWorkOrdersByStatusRow[]
const byMaintenanceType = await client.dashboard.listWorkOrdersByMaintenanceType()
// DashboardWorkOrdersByMaintenanceTypeRow[]
Summaries and tenant overview
Read summary views for work orders, assets, locations, and tenants.
Summary views
const workOrdersSummary = await client.dashboard.getWorkOrdersSummary()
// WorkOrdersSummaryRow[]
const assetsSummary = await client.dashboard.getAssetsSummary()
// AssetsSummaryRow[]
const locationsSummary = await client.dashboard.getLocationsSummary()
// LocationsSummaryRow[]
const tenantsOverview = await client.dashboard.getTenantsOverview()
// TenantsOverviewRow[]