Skip to main content

Integration Health API

Monitor the health and reliability of your space's integrations.

Endpoints Overview

MethodEndpointDescription
GET/spaces/{slug}/integration-healthGet health summary

Get Space Health

GET /spaces/{slug}/integration-health

Returns aggregated health metrics for all integrations in a space over a configurable lookback window.

Query Parameters

ParameterTypeDefaultDescription
daysinteger30Lookback window in days

Response

{
"space_id": "uuid",
"period_days": 30,
"total_events": 1250,
"success_count": 1180,
"error_count": 70,
"success_rate": 94.4,
"last_success_at": "2026-02-17T10:00:00Z",
"last_error_at": "2026-02-16T08:30:00Z",
"by_integration_type": [
{
"integration_type": "metadata_sync",
"total": 800,
"success": 780,
"errors": 20,
"last_event_at": "2026-02-17T10:00:00Z"
},
{
"integration_type": "quality_check",
"total": 350,
"success": 320,
"errors": 30,
"last_event_at": "2026-02-17T09:45:00Z"
}
]
}

Response Fields

FieldTypeDescription
space_idstringSpace identifier
period_daysintegerLookback window used
total_eventsintegerTotal integration events in the period
success_countintegerEvents with SUCCESS status
error_countintegerEvents with ERROR status
success_ratefloatSuccess percentage (0.0–100.0)
last_success_atstring | nullISO timestamp of most recent success
last_error_atstring | nullISO timestamp of most recent error
by_integration_typearrayBreakdown per integration type

Integration Types

TypeDescription
metadata_syncConnector metadata synchronization
quality_checkQuality check execution
profilingData profiling runs
webhookOutbound webhook delivery
alertAlert connector notifications

Use Cases

  • Dashboard widgets — Display health scores and trend sparklines
  • Alerting — Trigger notifications when success_rate drops below a threshold
  • SLA monitoring — Track last_success_at to detect stale integrations
  • Trend analysis — Compare health metrics across multiple spaces at the organization level