Get Dashboard Metrics
GET/api/starshipit/integration-instances/:integration_instance/dashboard
Returns aggregated operational metrics for the instance:
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
totalOrders— total orders in the local cache.ordersByStatus— count per order status. Statuses:Unshipped,Printed,Shipped,Delivered,Saved,Cancelled,Archived,Error,Unknown(every status is present, zero-filled).ordersByCarrier— top carriers by order count (up to 20).unprocessedWebhookEvents/failedWebhookEvents— inbound webhook events not yet processed, and events that recorded an error.unlinkedOrders— cached orders not linked to a sales order fulfillment.ordersLastSyncedAt/trackingInfoLastUpdatedAt— ISO-8601 timestamps of the most recent order sync and tracking refresh (null when never run).ordersChart— orders per day for the last 30 days, zero-filled so the series is continuous.
Authentication: Requires 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.