Do this in Connect
Review in-app notifications in VH3 Connect. Reports concepts stay on this page; Connect surfaces outcomes via notifications, cases, and assistants.
Report types
Eightreport_type values are valid on POST /reports/generate. Use the value that matches the operating rhythm you are automating. Other names — including daily_operations, weekly_summary, and executive_health_check — return HTTP 422.
Daily
Start of day (start_of_day)
Morning briefing: today’s scheduled work, yesterday’s carryovers, predicted overruns, repeat-visit alerts, and weather. Designed to land before dispatch.
Midday (midday)
Progress check while the day is still in play: completions so far, SLA risk, engineer capacity, and comparison to the previous period.
Close of business (close_of_business)
End-of-day wrap-up: completions, first-visit fix, punctuality, overruns, engineer leaderboard, and tomorrow’s outlook.
Day review (day_review)
Full-day recap: volume, timing, type breakdown, site activity, and comparison. Use this when you want the whole day in one pass, often the next morning for the previous day.
Weekly
Start of week (start_of_week)
Monday briefing: last week’s summary, this week’s scheduled volume, engineer workload, carryover, and weather outlook.
Midweek (midweek)
Wednesday pulse: week-to-date progress, daily breakdown, overrun trend, and whether the week is ahead or behind last week.
End of week (end_of_week)
Friday wrap-up: weekly completion, first-visit fix, site hotspots, type performance, and next week’s outlook.
Account monthly
Account monthly (account_monthly)
Per-customer month: volume, completion, site hotspots, job-type mix, timing, engineer activity, findings, and trend versus the previous month. Suitable for QBR prep. Requires contact_id. Pass month as YYYY-MM; if omitted, the previous calendar month is used.
Engineer leaderboards, site hotspots, and first-visit-fix sit inside these reports as sections. They are not separate report_type values. Call GET /reports/sections for the section list per type. Continuous alerts belong on Sentinels, not on this endpoint.
Report type values
Generating reports
Customer calls go to the Intelligence API withcompany_id, api_key, and report_type in the JSON body.
date is YYYY-MM-DD and defaults to today. Weekly types derive the ISO week from that date. Omit sections to include every section for the type; pass a list of section names from GET /reports/sections to generate a subset.
For an account report:
findings array, and the sections catalogue.
Findings
Every generate response includesfindings. Each Finding is one condition on one job:
- Still incomplete (
watch): planned before this report’s window and not completed. Start of day and start of week. - Overrunning (
act_now): still open and past its planned duration. Midday and midweek. - Finished late (
watch): finished past its planned duration. Close of business, day review, end of week, and midweek.
findings is []. Account monthly returns [] as well; account issues stay in the account sections.
The narrative uses UK English. Dates in the narrative are dd/mm/yy. Times use the 24-hour clock. Findings are returned when include_narrative is false.
Delivery options
Reports can be consumed through the channel that matches the work:- API response: use the generated JSON in custom apps or portals.
- Email delivery: send scheduled reports to named recipients.
- Slack/Teams: route briefings and exceptions to channels via automation.
- VH3 Connect: notifications, cases, and assistants surface outcomes in the app.
Scheduling
Trigger generation on demand via the API, or schedule it with automation. Common patterns:start_of_dayaround 06:30–07:00 before dispatch.close_of_businessafter the last job.start_of_weekon Monday morning for planning.account_monthlybefore client review meetings.
include_narrative is true.
How operators use reports
Reports work best as part of a regular operating loop:- Read start of day before standup, then ask Connie to explain one exception.
- Use end of week to decide which sentinel findings need cases.
- Use account monthly for QBR prep, then verify the cited jobs before sharing externally.
- Use engineer and site sections inside the daily and weekly reports to spot coaching or maintenance actions.
Related
Working with your operation
How reports fit into standups, account reviews, and case follow-through.
Sentinels
Continuous signals that can feed scheduled reports and briefings.
Connie
Ask follow-up questions against report findings with citations.
Reports API
Request fields, Findings, valid report types, and the sections catalogue.