Get Dashboard Metrics
GET/api/shiprush/instances/:integration_instance/dashboard
Returns just the live dashboard summary for a ShipRush integration instance — the lightweight refresh endpoint for the dashboard widget, without the full instance settings payload.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Path parameter:
- instance: the numeric ID of the ShipRush integration instance.
The response "data" object contains:
- awaiting_shipment / on_hold / error: per-status feed-order counts.
- never_exported: feed rows created but never polled out by ShipRush yet (feed health).
- shipped_last_7_days: parcels shipped in the trailing week.
- writeback_errors: shipment writebacks that need review (failed processing, unknown orders, labels printed for orders cancelled in SKU.io). Credential failures are counted separately.
- shipment_writeback_errors: the part of writeback_errors recorded on shipments (e.g. a label printed for an order cancelled in SKU.io) — review and re-process these from the shipments list.
- event_writeback_errors: the part of writeback_errors recorded only on webhook events (e.g. a shipment for an order ShipRush did not get from the feed) — list them with filter[error.is_not_empty]=1 on the webhook events endpoint.
- unmapped_services: carrier/service pairs with no SKU shipping method mapped.
- total_orders: total feed rows for the instance.
- last_poll_at / last_poll_order_count: when ShipRush last polled the export feed and how many rows it took.
- has_recent_credential_failure: whether ShipRush was rejected with bad store credentials in the last 24h and has NOT polled successfully since.
- credential_failures_last_24h: number of store-credential rejections in the last 24 hours.
- has_shipping_api_token: whether a Shipping API token is configured (enables token-gated sync).
Returns 404 when the instance does not exist.
Authentication: Requires a Bearer token.
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.