List Channel Health Metrics
GET/api/channel-health/metrics
The metric catalogue: every metric Channel Health monitors on at least one channel, with its label, short label, direction (higher_is_better, lower_is_better, categorical), unit (percent, score, count, status), default target and rolling window per channel, the noun for one bad event and a link to the marketplace's own performance page.
channel-health:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Bearer token (Personal Access Token) with the channel-health:read scope. The user needs the Integrations › View permission.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
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.
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.