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).
integrations:readGrant 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
- 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.