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.

​
Dashboard

Returns a cached, dashboard-ready snapshot of tenant operational health. Five sections — pipeline, performance, workforce, assets, and knowledge — map to StatsDisplay UI payloads. No LLM; read-only Neo4j aggregation plus Weaviate object counts.

​
GET /dashboard

Tenant pulse snapshot. Query parameters:
ParamTypeRequiredDescription
company_idstringYesYour tenant identifier
api_keystringYesYour tenant API key
refreshbooleanNoBypass cache and force a fresh snapshot (default false)
Response fields:
FieldTypeDescription
company_idstringTenant identifier
generated_atstringISO 8601 snapshot time
cached_untilstringISO 8601 cache expiry (5-minute TTL)
sections.pipelineobjectJob lifecycle: totals, active, unassigned, in progress, completions, status breakdown
sections.performanceobjectLast 30 days: completion rate, first-visit-fix rate, avg start/end delta (minutes)
sections.workforceobjectEngineer counts, active today, avg jobs per engineer, top engineer
sections.assetsobjectCustomers, sites, vehicles, job types, job categories
sections.knowledgeobjectWeaviate depth: intake docs, outcome docs, customer summaries, chat sessions
Example: 
curl -G "https://api.vh3connect.io/api:kP8T1CK7/dashboard" \
  --data-urlencode "company_id=your-company-id" \
  --data-urlencode "api_key=your-api-key"
Force refresh: 
curl -G "https://api.vh3connect.io/api:kP8T1CK7/dashboard" \
  --data-urlencode "company_id=your-company-id" \
  --data-urlencode "api_key=your-api-key" \
  --data-urlencode "refresh=true"
Use cases:
  • Home screen: Single call to populate KPI tiles on first load.
  • Mobile summary: Lightweight operational overview without running separate aggregate calls.
  • Health monitoring: Internal or partner views of tenant graph and KB coverage.
  • Scheduled snapshots: n8n cron to archive pulse metrics for trend reporting.
Notes:
  • Cached 5 minutes per tenant; uncached typically 200–800ms, cached under 10ms.
  • Deterministic — same underlying data yields the same metrics.
  • Returns 502 if graph or vector store queries fail.