Get account health

GET/v1/connections/{id}/health

Coming soon

This route is not in the API yet. This page shows what it will do. Fields, examples and the playground arrive when it ships.

Returns the latest snapshot of the account's health. level is normalized: good, warning, at_risk, restricted or unknown; the native level stays in externalLevel. metrics has each indicator (such as claims_rate) in bps, with its threshold and period. penalties has the restrictions, with start and end.

marketapi refreshes the snapshot every 6 h. When level changes, the connection.health_changed webhook arrives with previousLevel. While there is no snapshot, the answer is 200 with level: unknown and observedAt: null.

Part of customer service.