Get Dashboard Metrics
GET/api/shippit/instances/:integration_instance/dashboard
Returns just the live dashboard summary for a Shippit integration instance — the lightweight refresh endpoint for the dashboard widget, without the full instance settings payload.
Path parameter:
- instance: the numeric ID of the Shippit integration instance.
The response "data" object contains:
- merchant: the resolved Shippit merchant profile (name, company_name, contact_name), or an "error" message when the merchant lookup failed.
- environment: "production" or "sandbox".
- order_state_counts: a map of Shippit order state to count.
- order_count / courier_count / warehouse_mapping_count: totals for the instance.
- auto_book / record_shipping_costs: current setting values.
- last_webhook_at / last_synced_at: ISO-8601 timestamps, or null when never run.
- webhook_url: the URL to paste into your Shippit account for webhook delivery.
- is_connected: whether the Shippit merchant lookup currently succeeds.
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.