Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vh3.ai/llms.txt

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

​
Reports Guide

VH3 AI generates structured operational reports automatically — no manual data pulling, no spreadsheet assembly, no waiting for someone to “run the numbers.” Reports read directly from the knowledge graph and deliver intelligence in the format your team needs.

​
Report types

​
Daily operations

A snapshot of yesterday’s work — jobs completed, SLA performance, notable events, and any sentinel triggers. Designed to land in an ops manager’s inbox before the morning standup.

​
Weekly summary

Trends, rankings, and operational highlights across the week. Identifies patterns that aren’t visible in a single day’s data.

​
Account monthly

Per-customer performance report covering job volumes, SLA metrics, response times, and any flagged risks. Suitable for sharing directly with FM clients.

​
Executive health check

A five-dimension health assessment spanning up to three years of operational history. Scored across quality, efficiency, coverage, risk, and growth.

​
Engineer performance

Individual breakdown — completion rates, SLA punctuality, first-time-fix rates, customer feedback, and workload distribution.

​
Site health

Site-level trends — fault frequency, repeat visit rates, equipment failure patterns, and maintenance trajectory.

​
Customer intelligence

Relationship summary — job history, risk signals, communication patterns, commercial activity, and recommended actions.

​
Sentinel digest

Aggregated summary of all sentinel triggers for a given period — useful as a standalone report or as a section within a broader briefing.

​
Generating reports

curl -X POST "https://api.vh3connect.io/api:kP8T1CK7/reports/generate" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "companyId": "your-company-id",
    "reportType": "weekly_summary",
    "startDate": "2024-11-04",
    "endDate": "2024-11-10"
  }'
Reports are generated asynchronously. The response includes a task ID you can poll for completion.

​
Delivery options

Reports can be consumed via:
  • API polling — retrieve the generated report content via the API
  • Email delivery — configure automated delivery to specified recipients
  • Slack/Teams — route to channels via n8n automation
  • VH3 Connect — view rendered reports in the application dashboard

​
Scheduling

Report generation can be triggered on demand via the API, or scheduled via automation (n8n cron triggers) for hands-free delivery at the cadence your operation needs.