Skip to main content

Get Dashboard Metrics

GET 

/api/shipbob/:instance/dashboard

Aggregate KPI counters and sync/webhook health for the instance dashboard.

Required scope: integrations:read

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

Authentication: Requires Bearer token.

Returns order/shipment/product/return/receiving counters plus per-entity last-sync timestamps, connection state, and webhook health.

sync_status.connection_state is active, or inactive once ShipBob has rejected the API token (HTTP 401) — until a new token is verified.

sync_status.outages lists syncs that ShipBob is currently failing to serve (HTTP 5xx or unreachable), keyed by sync (orders, shipments, inventory, returns, receiving_orders, tracking, products, fulfillment_centers, shipping_methods, billing). Each entry has since (when the outage began), last_failed_at, consecutive_runs (scheduled runs skipped so far) and reason (ShipBob's message). SKU.io retries automatically and removes the entry on the next successful sync. An empty object means ShipBob is healthy.

Request​

Responses​

OK

Response Headers
    Content-Type