Get Dashboard Stats
GET/api/api-shipping-providers/:provider-id/dashboard
Get dashboard statistics for a shipping provider instance.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
URL Parameters:
| Parameter | Type | Description |
|---|---|---|
id | integer | The integration instance ID |
Response: Returns aggregated stats for the provider.
Permission: Integrations → View (integrations.show). Without it the request is refused with a 403 naming the missing permission.
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
Response Headers
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.