Get Dashboard
GET/api/pinnacle/instances/:instance/dashboard
Returns summary metrics for the instance without calling Pinnacle: order counts (awaiting_pickup = registered or pickup scheduled; in_transit = picked up, at hub or delivery scheduled; registration_failed; delivered in the last 30 days; with_exception; total), per-status counts, connection health, webhook health for the last 24 hours, the last orders / tracking / proof-of-delivery sync times, the 10 most recent tracking events and the 5 most recently updated orders.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: requires a Bearer token (Personal Access 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
Response Headers
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.