Skip to main content

Get Dashboard Metrics

GET 
/api/shippo/instances/:integration_instance/dashboard

Returns live summary metrics for the instance:

  • labels_30d, spend_30d, spend_currency: labels purchased and postage spend over the last 30 days.
  • in_transit, delivered_30d: labels currently in transit, and delivered in the last 30 days.
  • refunds_pending: labels with a refund still pending at Shippo.
  • unlinked_labels: labels not linked to a fulfillment order (e.g. bought directly in Shippo).
  • label_count, order_count: totals stored for the instance.
  • orders_by_status: order counts keyed by Shippo order status (PAID, SHIPPED, SUBMIT_FAILED, …).
  • submit_failed_orders: orders whose push to Shippo failed.
  • failed_webhooks: inbound webhook events that failed processing.
  • unmapped_service_levels: carrier service levels not mapped to a shipping method.
  • usable_warehouse_mappings: enabled warehouse sender addresses registered at Shippo.
  • carrier_count: active carrier accounts.
  • last_synced_at, orders_last_synced_at, labels_last_synced_at, carriers_last_synced_at, tracking_last_synced_at, last_webhook_at, webhook_subscribed_at: ISO-8601 timestamps (UTC) or null.
  • auth_error_at, is_healthy, is_test: connection health and mode.
Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Returns 404 for an unknown instance.

Authentication: Requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type