Skip to main content

Get Shiptheory Dashboard Metrics

GET 

/api/shiptheory/:integration_instance/dashboard

Returns just the live dashboard summary for a Shiptheory instance — the lightweight refresh for the dashboard widget without the full instance settings payload. The "data" object contains per-status order counts, KPI totals (awaiting_booking_count, booked_last_7_days_count, failed_count, ignored_count, methods_on_rules_engine_count), entity counts, per-entity last-sync timestamps, the connection state, is_connected, and a polling_notice (Shiptheory is polling-only — there are no webhooks).

Required scope: integrations:read

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

Path parameter:

  • integration_instance: the numeric id of the Shiptheory integration instance.

Authentication: requires a Bearer token.

Returns 404 when the instance does not exist.

Request​

Responses​

OK

Response Headers
    Content-Type