Skip to main content

Get Channel Health Summary

GET 
/api/channel-health/summary

Returns the latest value of every monitored seller-performance metric — one row per integration instance × marketplace × metric × dimension × source — with SKU's evaluation (status: healthy, at_risk, breached, no_data), the remaining headroom (more bad events before the target is breached), the recovery date, the date the current status began, open shipment-flag counts and up to 5 sales orders behind the bad events (cause_orders, with the full count in cause_order_count): flags already counted against the metric first (expired, or open and unfixable), then still-fixable ones marked pending: true; marketplace-itemised rows the seller isn't accountable for (e.g. customer-requested cancellations) are left out.

Required scope: channel-health:read

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

alert_id / snoozed_until are the calling user's own open alert for the metric, if any (snooze it with Snooze Alert).

sources lists every monitored instance × marketplace, including ones whose first report hasn't arrived yet (state = no_data, no attempt). state is ok, refused (the marketplace denied access — e.g. a missing SP-API role), failing or no_data.

meta: last_synced_at, next_sync_at (the next scheduled daily sync), refresh_available_at (null while a manual refresh is allowed) and open_flag_count.

SKU-estimate rows (source = sku_computed, e.g. Valid Tracking Rate per Amazon category with dimension = category:automotive) are SKU's own calculation from the shipments it confirmed.

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

Request​

Responses​

OK

Response Headers
    Content-Type