Orders dashboard
API operation: Open the endpoint in Scalar
Use GET /orders/dashboard to summarize the orders visible to the authenticated caller by order status. The current public operation is Order.dashboard.
Visibility is role-dependent:
- administrators can summarize project orders;
- business managers are limited through businesses they own;
- drivers are limited to orders assigned to them;
- driver managers are limited through administered driver groups;
- call-center agents can access the operation under the current middleware.
Use the operation's where and sparse-field parameters as documented. The optional v parameter is part of its contract.
Do not interpret those fields as calculated monetary totals or an order list without release-specific evidence.
mode=dashboard is used on other order routes; it is not required by GET /orders/dashboard.
Authentication, response fields, and errors are specific to this operation.
OpenAPI reference
Operation: GET /orders/dashboard
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
params | string | No | Comma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields. |
v | integer | No | — |
Responses
| Code | Description |
|---|---|
| 200 | OK (Envelope) |
| 400 | Bad Request (ErrorResponse) |
| 401 | Unauthorized |
| 404 | Not Found |
| 429 | Too Many Requests (ErrorResponse) |
| 500 | Internal Server Error (ErrorResponse) |
| 503 | Service Unavailable (ErrorResponse) |