Skip to main content

​
GET /api/v1/report/?format=pdf

Generate a concise 1-page executive PDF report for plant managers and executives.

​
Path Parameters

​
asset_id
string
required
Asset identifier (e.g., Motor-01)

​
Query Parameters

​
format
string
Must be pdf (default)

​
Response

Returns a PDF file download with:
  • Health Grade: Letter grade (A/B/C/D/F) based on health score
  • Risk Level: Color-coded badge (LOW/MODERATE/HIGH/CRITICAL)
  • Key Metrics: Health score, RUL, DI, damage rate
  • Maintenance Window: Estimated days until recommended service
  • Timestamp: Report generation time

​
Example

cURL
curl -X GET "https://predictive-maintenance-uhlb.onrender.com/api/v1/report/Motor-01?format=pdf" \
  -H "Accept: application/pdf" \
  --output motor01-report.pdf
Python
import requests

response = requests.get(
    "https://predictive-maintenance-uhlb.onrender.com/api/v1/report/Motor-01",
    params={"format": "pdf"}
)

with open("motor01-report.pdf", "wb") as f:
    f.write(response.content)

​
Health Grade Scale

Health ScoreGradeRisk LevelInterpretation
90-100ALOWExcellent condition
75-89BLOWGood condition
50-74CMODERATEFair condition, monitor
25-49DHIGHPoor condition, schedule maintenance
0-24FCRITICALFailing, immediate action required

​
File Naming

Downloaded files follow the pattern: 
health-report_{asset_id}_{timestamp}.pdf
Example: health-report_Motor-01_2026-03-02T10-30-00Z.pdf
This report is designed for quick executive briefings. For technical analysis, use the Industrial PDF instead.

​
Status Codes

  • 200 - Report generated successfully
  • 404 - Asset not found or no health data available
  • 503 - Report generation failed

​
Report Contents

The executive PDF includes:
  1. Header: Asset ID, timestamp, report type
  2. Health Summary Card:
    • Health Grade (A-F)
    • Health Score (0-100)
    • Risk Level badge
  3. Metrics Grid:
    • Degradation Index (DI)
    • Damage Rate (per hour)
    • Remaining Useful Life (RUL)
    • Lifetime Anomaly Batches
  4. Maintenance Window: Days until recommended service
  5. Footer: Report generation metadata
Generate reports after each shift change or weekly for routine monitoring. The report uses the latest health assessment from /api/v1/status/{asset_id}.

Analyst Excel

Multi-sheet workbook with raw data

Industrial PDF

5-page technical certificate

Build docs developers (and LLMs) love

Get started for freeTalk to us