Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.appliedaifoundation.org/llms.txt

Use this file to discover all available pages before exploring further.

​
Base URL

The dashboard is hosted on Vercel. All API endpoints are available at: 
https://ballast-water-treatment-system.apps.metaweave.in
All endpoints are GET-only and return application/json. All responses include Cache-Control: no-store — data is always fresh from the database.

​
GET /api/stats

Combined overview data — runs four parallel database queries and returns a single response object. Used by the Overview tab. Parameters: None Response: 
{
  "latestTelemetry": { ...TelemetryReading },
  "latestHealth": {
    "timestamp": "2026-04-30T00:00:00Z",
    "overall_score": 82,
    "risk_level": "LOW",
    "components": {
      "uv_health": 88,
      "lamp_health": 79,
      "power_efficiency": 84,
      "thermal_health": 91
    }
  },
  "recentEvents": [ ...Event[] ],
  "monthlyAvg": {
    "avgUVIntensity": 645.2,
    "avgPowerOutput": 87.4,
    "avgFlowRate": 95.3
  }
}

​
GET /api/telemetry/latest

Most recent telemetry reading. Used by the Compliance tab and Trend Analysis date initialisation. Parameters: None Response: Single TelemetryReading object with all 65+ fields. See Telemetry Fields Reference.

​
GET /api/telemetry/history

Historical telemetry over a time window. Parameters:
ParameterTypeDefaultDescription
hoursinteger24Number of hours back from the latest record
Response: Array of TelemetryReading objects ordered by timestamp ascending.

​
GET /api/telemetry/aggregated

Time-bucketed telemetry. Used as Stage 1 data for Trend Analysis, Comparative Analysis, and Data Export. Parameters:
ParameterTypeDefaultDescription
intervalday | hourdayAggregation bucket size
startDateISO string—Start of date range (takes precedence over hours)
endDateISO string—End of date range
hoursinteger720Fallback window if startDate/endDate not provided
Response: Array of aggregated rows. Each row contains:
  • timestamp — bucket start
  • UVR_INTENSITY, UVR_POWER_OUTPUT, UVR_WATER_TEMP, SYS_FLOW_RATE, SYS_PRESSURE, AVG_LAMP_EFFICIENCY, FAILED_LAMP_COUNT
  • Per-lamp data for all 16 lamps: LAMP_XX_EFFICIENCY, LAMP_XX_POWER, LAMP_XX_RUNTIME
  • recordCount — number of raw records aggregated into this bucket

​
GET /api/telemetry/chunked

Paginated raw telemetry records. Used as Stage 2 streaming data. Parameters:
ParameterTypeDefaultDescription
startDateISO stringrequiredStart of date range
endDateISO stringrequiredEnd of date range
offsetinteger0Record offset for pagination
limitinteger500Records per page
Response: 
{
  "data": [ ...TelemetryReading[] ],
  "pagination": {
    "offset": 0,
    "limit": 500,
    "total": 17531,
    "hasMore": true
  }
}

​
GET /api/telemetry/runtime-analysis

Telemetry records organised for runtime-based lamp degradation analysis. Used by the Trend Analysis runtime charts. Parameters:
ParameterTypeDefaultDescription
startDateISO string—Optional start filter
endDateISO string—Optional end filter
Response: Array of up to 10,000 records containing: timestamp, UVR_INTENSITY, UVR_POWER_OUTPUT, and LAMP_XX_RUNTIME/EFFICIENCY/POWER for all 16 lamps.

​
GET /api/health

Latest health score records. Parameters:
ParameterTypeDefaultDescription
limitinteger100Maximum number of records to return
Response: Array of health records ordered by timestamp descending: 
[{
  "timestamp": "2026-04-30T00:00:00Z",
  "overall_score": 82,
  "risk_level": "LOW",
  "month": 4,
  "componentsUvHealth": 88,
  "componentsPowerEfficiency": 84,
  "componentsLampHealth": 79,
  "componentsThermalHealth": 91
}]
Note: component fields are flat (not nested) in this endpoint’s response. Use /api/health/aggregated for nested component structure.

​
GET /api/health/aggregated

Time-bucketed health scores. Used by the Trend Analysis health evolution chart. Parameters:
ParameterTypeDefaultDescription
intervalday | hourdayAggregation bucket size
startDateISO string—Start of date range
endDateISO string—End of date range
limitinteger—Fallback if dates not provided
Response: 
[{
  "timestamp": "2026-04-30T00:00:00Z",
  "overall_score": 82,
  "components": {
    "uv_health": 88,
    "lamp_health": 79,
    "power_efficiency": 84,
    "thermal_health": 91
  },
  "recordCount": 480
}]

​
GET /api/events

Process lifecycle and alarm events. Parameters:
ParameterTypeDefaultDescription
limitinteger100Maximum number of records
typestring—Filter by event type: PROCESS_START, PROCESS_STOP, or ALARM_TRIGGERED
Response: 
[{
  "timestamp": "2026-04-30T08:15:00Z",
  "event_type": "PROCESS_START",
  "description": "Ballast operation started at Port Klang",
  "data": {
    "operation_type": "BALLAST",
    "location": "Port Klang",
    "target_flow": 100.5
  }
}]

​
GET /api/predictions

ML predictions for all UV lamp components. Parameters:
ParameterTypeDefaultDescription
limitinteger100Maximum number of prediction records
Response: 
[{
  "timestamp": "2026-04-30T00:00:00Z",
  "component_id": "LAMP_01",
  "component_type": "UV_LAMP",
  "predictions": {
    "remaining_useful_life_hours": 450,
    "failure_probability": 0.62,
    "efficiency_percent": 81.3
  },
  "current_state": {
    "runtime_hours": 2150,
    "efficiency_percent": 81.3,
    "status": "OPERATIONAL"
  }
}]
See RUL Algorithm for how the Predictive Maintenance tab deduplicates and ranks these records.