API reference · Event Health
Event Health
Per-event confidence score and risk surface, refreshed in the background.
★
Aspirational surface. This resource is part of the developer-platform roadmap. The field shapes follow the same conventions as live resources and are stable for prototype integrations.
Endpoints
GET
/v1/events/{id}/health
Health for one event
GET
/v1/events/health/upcoming
Bulk health for upcoming events
Object shape
The health object summarizes the risk surface for a future event into a single confidence score.
| Field | Type | Description | |
|---|---|---|---|
| event_id | string | Reference event. | |
| score | number | 0.0–1.0 confidence the event will start on time. | |
| label | string | on_track, at_risk, likely_late, blocked. | |
| risks | array | Per-risk breakdown — type (traffic, weather, conflict, connection), severity, detail. | |
| calculated_at | datetime | Snapshot time. |
Retrieve health for one event
HTTP
GET /v1/events/{id}/healthBulk health for upcoming events
HTTP
GET /v1/events/health/upcoming
Filters: user_id, limit (default 25, max 100), horizon_hours (default 24).
Use this for dashboard widgets. Computed lazily; expect occasional score: null for events whose health hasn't yet been computed.
How it's scored
A weighted blend of:
- Traffic delta vs typical (40%)
- Weather warning severity (25%)
- Departure window margin (20%)
- Conflicts with other events (10%)
- Connection health (5%) — disconnected provider hurts the score because we may be missing fresh data.
Weights are tuned by the team and may shift between API versions.