Get Product Data Health Metrics
GET/api/product-data-health/metrics
Aggregated product data-health metrics for the Product Data Health dashboard: product-type distribution, active/archived breakdown, unit-cost health (>0 / =0 / null), brand and supplier coverage, supplier-price health, kit/bundle component gaps, pricing coverage, image health, and sales-channel mapping coverage.
products:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Image health: products_with_image / products_without_image reflect image presence (a primary or any product image). products_with_broken_image counts products whose primary image was checked and found unresolvable by the on-demand image-health check (see POST /api/product-data-health/check-image-health). image_health_last_checked_at is the most recent time any product image was validated (UTC, ISO-8601), or null if no check has ever run.
Authentication: Requires Bearer token (scope: products read-write).
Optional filters (all narrow every metric):
- archived_status: active | archived — restrict to active or archived products
- brand_id: integer — restrict to a single brand
- default_supplier_id: integer — restrict to products whose default supplier matches
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.