TGM Expert provides comprehensive dashboards and analytics for monitoring maintenance operations, asset health, and key performance indicators (KPIs).

Table of Contents¶

• Overview
• Dashboard KPIs
• Unit KPIs
• Search & Export
• Compliance Audit
• Inventory Forecast
• User Activity

Overview¶

Key Features¶

• Real-Time KPIs - Live operational metrics
• Configurable Periods - Weekly, monthly, quarterly, yearly views
• Unit-Specific Analytics - Drill down to individual units
• Export Capabilities - Export data in multiple formats
• Compliance Tracking - Audit and compliance metrics

Dashboard Architecture¶

┌─────────────────────────────────────────────────────────────┐
│                     Executive Dashboard                      │
├─────────────┬─────────────┬─────────────┬──────────────────┤
│   Assets    │ Maintenance │   Alerts    │    Financial     │
│   Health    │   Status    │   Active    │    Summary       │
├─────────────┴─────────────┴─────────────┴──────────────────┤
│                    Trend Charts & Graphs                     │
└─────────────────────────────────────────────────────────────┘

Dashboard KPIs¶

Get Dashboard KPIs¶

# Default (30 days)
curl -X GET "https://api.tgm-expert.com/dashboard/kpis" \
  -H "Authorization: Bearer $TOKEN"

# Custom period
curl -X GET "https://api.tgm-expert.com/dashboard/kpis?periodDays=90" \
  -H "Authorization: Bearer $TOKEN"

# Date range
curl -X GET "https://api.tgm-expert.com/dashboard/kpis/range?startDate=2026-01-01T00:00:00Z&endDate=2026-01-31T23:59:59Z" \
  -H "Authorization: Bearer $TOKEN"

KPI Response¶

{
  "data": {
    "period": {
      "start": "2026-01-01T00:00:00Z",
      "end": "2026-01-31T23:59:59Z",
      "days": 30
    },
    "maintenance": {
      "totalInspections": 45,
      "completedInspections": 40,
      "overdueInspections": 2,
      "inspectionCompletionRate": 88.9,
      "totalInterventions": 28,
      "completedInterventions": 25,
      "averageInterventionTime": 4.5,
      "totalWorkOrders": 35,
      "openWorkOrders": 8,
      "completedWorkOrders": 27,
      "workOrderCompletionRate": 77.1
    },
    "failures": {
      "totalFailures": 5,
      "criticalFailures": 1,
      "majorFailures": 2,
      "minorFailures": 2,
      "mtbf": 720,
      "mttr": 8.5,
      "failuresByType": {
        "MECHANICAL": 2,
        "ELECTRICAL": 2,
        "INSTRUMENTATION": 1
      }
    },
    "assets": {
      "totalAssets": 500,
      "operationalAssets": 480,
      "underMaintenance": 15,
      "degradedAssets": 5,
      "averageHealthScore": 85.2,
      "assetsApproachingEOL": 12
    },
    "alerts": {
      "activeAlerts": 8,
      "acknowledgedAlerts": 3,
      "resolvedToday": 5,
      "alertsByPriority": {
        "CRITICAL": 2,
        "HIGH": 3,
        "MEDIUM": 3
      }
    },
    "financial": {
      "maintenanceCostYTD": 450000,
      "budgetUtilization": 45,
      "costPerUnit": 9000,
      "laborCost": 180000,
      "partsCost": 200000,
      "servicesCost": 70000
    }
  }
}

Preset Periods¶

Unit KPIs¶

Get Unit-Specific KPIs¶

curl -X GET "https://api.tgm-expert.com/dashboard/units/100/kpis?periodDays=30" \
  -H "Authorization: Bearer $TOKEN"

Unit KPI Response¶

{
  "data": {
    "unitId": 100,
    "unitName": "Turbine Unit 1",
    "period": {
      "start": "2026-01-01T00:00:00Z",
      "end": "2026-01-31T23:59:59Z"
    },
    "availability": {
      "availabilityPercent": 98.5,
      "operatingHours": 710,
      "downtimeHours": 10.8,
      "plannedOutageHours": 8,
      "unplannedOutageHours": 2.8
    },
    "maintenance": {
      "inspectionsCompleted": 4,
      "interventionsCompleted": 3,
      "workOrdersClosed": 5,
      "preventiveMaintenanceCost": 15000,
      "correctiveMaintenanceCost": 8000
    },
    "reliability": {
      "mtbf": 1440,
      "mttr": 5.4,
      "failureCount": 1,
      "reliabilityScore": 95.2
    },
    "healthScore": {
      "overall": 88,
      "mechanical": 90,
      "electrical": 85,
      "instrumentation": 89
    },
    "sensors": {
      "totalSensors": 25,
      "activeSensors": 24,
      "alertingSensors": 2,
      "averageReadingsPerDay": 3600
    },
    "components": {
      "total": 45,
      "operational": 43,
      "degraded": 2,
      "underMaintenance": 0
    }
  }
}

Search & Export¶

Global Search¶

curl -X GET "https://api.tgm-expert.com/search?q=governor+valve" \
  -H "Authorization: Bearer $TOKEN"

Response:

{
  "data": {
    "query": "governor valve",
    "totalResults": 15,
    "results": [
      {
        "type": "component",
        "id": 1000,
        "title": "Governor Valve GV-001",
        "description": "Main governor valve for Unit 1",
        "url": "/api/components/1000"
      },
      {
        "type": "inspection",
        "id": 50,
        "title": "Governor Valve Inspection",
        "description": "Quarterly inspection",
        "url": "/api/inspections/50"
      },
      {
        "type": "drawing",
        "id": 25,
        "title": "Governor Valve Assembly Drawing",
        "url": "/api/drawings/25"
      }
    ],
    "byType": {
      "component": 3,
      "inspection": 5,
      "intervention": 4,
      "drawing": 2,
      "document": 1
    }
  }
}

Search Filters¶

# Filter by type
GET /search?q=valve&type=component

# Filter by location
GET /search?q=valve&locationId=1

# Filter by date range
GET /search?q=valve&createdAfter=2025-01-01

# Combined filters
GET /search?q=valve&type=inspection&status=COMPLETED

Export Data¶

# Export inspections to CSV
curl -X GET "https://api.tgm-expert.com/export/inspections?format=csv&startDate=2026-01-01&endDate=2026-01-31" \
  -H "Authorization: Bearer $TOKEN" \
  -o inspections.csv

# Export to Excel
curl -X GET "https://api.tgm-expert.com/export/inspections?format=xlsx" \
  -H "Authorization: Bearer $TOKEN" \
  -o inspections.xlsx

# Export to PDF
curl -X GET "https://api.tgm-expert.com/export/inspections?format=pdf" \
  -H "Authorization: Bearer $TOKEN" \
  -o inspections.pdf

Export Formats¶

Exportable Resources¶

Compliance Audit¶

Compliance Dashboard¶

curl -X GET "https://api.tgm-expert.com/compliance-audit/dashboard" \
  -H "Authorization: Bearer $TOKEN"

Response:

{
  "data": {
    "overallComplianceScore": 92.5,
    "byCategory": {
      "safety": 95,
      "environmental": 90,
      "regulatory": 93,
      "internal": 92
    },
    "upcomingAudits": [
      {
        "id": 10,
        "name": "Annual Safety Audit",
        "dueDate": "2026-03-15",
        "status": "SCHEDULED"
      }
    ],
    "recentFindings": [
      {
        "id": 5,
        "category": "SAFETY",
        "severity": "MEDIUM",
        "description": "Missing safety signage",
        "status": "IN_PROGRESS",
        "dueDate": "2026-02-28"
      }
    ],
    "overdueItems": 2,
    "completedThisMonth": 8
  }
}

Compliance Metrics¶

Inventory Forecast¶

Spare Parts Forecast¶

curl -X GET "https://api.tgm-expert.com/inventory-forecast?periodMonths=6" \
  -H "Authorization: Bearer $TOKEN"

Response:

{
  "data": {
    "forecastPeriod": {
      "start": "2026-02-01",
      "end": "2026-07-31",
      "months": 6
    },
    "summary": {
      "totalItems": 500,
      "lowStockItems": 25,
      "criticalItems": 5,
      "projectedShortages": 8,
      "reorderRecommendations": 15
    },
    "criticalParts": [
      {
        "partId": 100,
        "name": "Governor Seal Kit",
        "currentStock": 2,
        "reorderPoint": 5,
        "averageMonthlyUsage": 1.5,
        "projectedStockoutDate": "2026-03-15",
        "recommendedOrder": 10
      }
    ],
    "reorderRecommendations": [
      {
        "partId": 100,
        "name": "Governor Seal Kit",
        "quantity": 10,
        "estimatedCost": 5000,
        "priority": "HIGH"
      }
    ],
    "monthlyForecast": [
      {
        "month": "2026-02",
        "projectedUsage": 150000,
        "projectedCost": 75000
      }
    ]
  }
}

Forecast Parameters¶

# Specific parts
GET /inventory-forecast?partIds=100,101,102

# By location
GET /inventory-forecast?locationId=1

# By category
GET /inventory-forecast?category=HYDRAULIC

# Extended forecast
GET /inventory-forecast?periodMonths=12

User Activity¶

User Activity Dashboard¶

curl -X GET "https://api.tgm-expert.com/user-activity?periodDays=30" \
  -H "Authorization: Bearer $TOKEN"

Response:

{
  "data": {
    "period": {
      "start": "2026-01-01",
      "end": "2026-01-31"
    },
    "summary": {
      "activeUsers": 45,
      "totalLogins": 1250,
      "averageSessionDuration": 45,
      "peakHour": 10
    },
    "byRole": {
      "ADMIN": 5,
      "MANAGER": 10,
      "OPERATOR": 20,
      "TECHNICIAN": 10
    },
    "topUsers": [
      {
        "userId": 10,
        "name": "John Smith",
        "logins": 45,
        "actionsPerformed": 320
      }
    ],
    "activityByType": {
      "inspections_created": 45,
      "interventions_completed": 28,
      "work_orders_created": 35,
      "documents_uploaded": 50
    },
    "dailyActivity": [
      {"date": "2026-01-01", "logins": 40, "actions": 250},
      {"date": "2026-01-02", "logins": 42, "actions": 280}
    ]
  }
}

API Endpoints Summary¶

Dashboard¶

Search & Export¶

Analytics¶

Best Practices¶

1. Use Appropriate Time Periods¶

• Daily Operations: Use weekly view
• Management Reviews: Use monthly view
• Strategic Planning: Use quarterly/yearly view

2. Set Up Alerts for KPIs¶

Monitor critical KPIs with thresholds:

{
  "kpiAlerts": [
    {"kpi": "workOrderCompletionRate", "threshold": 80, "type": "MIN"},
    {"kpi": "mttr", "threshold": 24, "type": "MAX"},
    {"kpi": "activeAlerts", "threshold": 10, "type": "MAX"}
  ]
}

3. Regular Export for Reporting¶

Schedule regular exports for management reports:

# Weekly inspection report
/export/inspections?format=pdf&lastDays=7

4. Drill Down for Details¶

Start with dashboard, then drill down: 1. Dashboard KPIs → Identify issues 2. Unit KPIs → Locate problem area 3. Component details → Root cause

5. Compare Periods¶

Compare current vs previous periods:

# Current month
GET /dashboard/kpis?periodDays=30

# Previous month
GET /dashboard/kpis/range?startDate=2025-12-01&endDate=2025-12-31