Skip to main content

Provider Monitoring API Reference

The Provider Monitoring API exposes endpoints to query provider health, inspect daily synthetic canary check executions, view outlier alerts, and resolve system incidents.

GET /health/providers​

Retrieve current health and availability summary across all financial data providers.

Response Example​

{
  "total_providers": 14,
  "healthy_count": 13,
  "degraded_count": 1,
  "providers": [
    {
      "name": "ZoneBourse",
      "is_healthy": true,
      "success_rate": 0.98,
      "avg_latency_ms": 320,
      "last_check_at": "2026-08-11T06:00:00Z"
    },
    {
      "name": "Investing",
      "is_healthy": false,
      "success_rate": 0.65,
      "avg_latency_ms": 1450,
      "last_check_at": "2026-08-11T06:00:00Z"
    }
  ]
}

GET /health/providers/{name}​

Detailed health statistics, historical latency metrics, and recent outlier events for a single provider.

GET /health/alerts​

Retrieve active or resolved provider quality alerts.

Parameters​

ParameterTypeRequiredDefaultDescription
severitystring❌—Filter by severity (critical, warning, info)
providerstring❌—Provider name
include_resolvedboolean❌falseInclude historical resolved alerts

POST /health/alerts/{id}/resolve​

Manually mark an alert as resolved with an optional resolution note.

Request Body​

{
  "resolution_note": "Upstream rate limit cleared by provider support."
}

POST /health/canary/run​

Trigger an immediate background Canary health check across all registered providers or a single target provider.

GET /health/canary/history​

Historical execution log of daily synthetic canary checks.

GET /health/stats​

Global data quality statistics over a 7-day rolling window.