List Channel Health Thresholds

GET 
/api/channel-health/thresholds

Effective warn thresholds for every monitored metric × channel (built-in defaults merged with the tenant's settings), followed by any per-instance overrides. Each row includes the marketplace target it is judged against (target_source: marketplace when the marketplace reported it, default otherwise) and the built-in defaults.

Required scope: channel-health:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

• warn_value: the metric is At risk once it crosses this level
• clear_margin: an open alert only clears once the value is better than the warn level by this much
• min_denominator: below this many orders/shipments, alerts carry a low-volume note
• small_sample_warning: also At risk when the next single bad event would breach the target
• enabled: off stops alerting on the metric

Authentication: Bearer token (Personal Access Token) with the channel-health:read scope. The user needs the Integrations › View permission.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.