Get Dashboard Metrics
GET/api/shipbob/:instance/dashboard
Aggregate KPI counters and sync/webhook health for the instance dashboard.
integrations:readGrant 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
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.