Dashboard
Read the figures behind the dashboard and manage dashboard layouts.
Paths are relative to https://api.rushhourapp.com/api/v1. See the API reference overview for how to read each entry.
Dashboard
| Method | Path | Summary |
|---|---|---|
GET | /Dashboard/ArAging | Get open receivables grouped into aging buckets. |
GET | /Dashboard/Definitions | List your company's dashboards and your personal dashboards. |
POST | /Dashboard/Definitions | Create a dashboard layout. |
PUT | /Dashboard/Definitions/{id} | Update a dashboard layout. |
DELETE | /Dashboard/Definitions/{id} | Delete a dashboard layout. |
POST | /Dashboard/Definitions/{id}/SetDefault | Set or clear a company dashboard as the default dashboard. |
GET | /Dashboard/OnTimeRate | On-time delivery rate over a trailing window (on-time % widget). |
GET | /Dashboard/RevenueTrend | Invoiced revenue per day over a trailing window (revenue trend widget). |
GET | /Dashboard/TodaySummary | Get today's live summary for the dashboard. |
GET | /Dashboard/UnbilledClosedOrders | Closed orders with no invoice over a trailing window (revenue-leakage widget). |
GET /Dashboard/ArAging
Get open receivables grouped into aging buckets.
Required access: the View Invoices and Payments permission.
Response: envelope; data is ArAgingDto.
GET /Dashboard/Definitions
List your company's dashboards and your personal dashboards.
Response: envelope; data is array of DashboardDefinitionDto.
POST /Dashboard/Definitions
Create a dashboard layout.
Request body: SaveDashboardDefinitionRequest (JSON).
Response: envelope; data is DashboardDefinitionDto.
PUT /Dashboard/Definitions/{id}
Update a dashboard layout.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer (int32) | Yes |
Request body: SaveDashboardDefinitionRequest (JSON).
Response: envelope; data is DashboardDefinitionDto.
DELETE /Dashboard/Definitions/{id}
Delete a dashboard layout.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer (int32) | Yes |
Response: envelope; data has no documented shape.
POST /Dashboard/Definitions/{id}/SetDefault
Set or clear a company dashboard as the default dashboard.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer (int32) | Yes | |
value | query | boolean | No | Default: true. |
Response: envelope; data has no documented shape.
GET /Dashboard/OnTimeRate
On-time delivery rate over a trailing window (on-time % widget).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
days | query | integer (int32) | No | Default: 30. |
graceMinutes | query | integer (int32) | No | Default: 30. |
Response: envelope; data is OnTimeRateDto.
GET /Dashboard/RevenueTrend
Invoiced revenue per day over a trailing window (revenue trend widget).
Required access: the View Invoices and Payments permission.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
days | query | integer (int32) | No | Default: 30. |
Response: envelope; data is RevenueTrendDto.
GET /Dashboard/TodaySummary
Get today's live summary for the dashboard.
Response: envelope; data is TodaySummaryDto.
GET /Dashboard/UnbilledClosedOrders
Closed orders with no invoice over a trailing window (revenue-leakage widget).
Required access: the View Invoices and Payments permission.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
months | query | integer (int32) | No | Default: 3. |
Response: envelope; data is UnbilledClosedOrdersDto.
Order statistics
| Method | Path | Summary |
|---|---|---|
GET | /OrderStatistic/DailyOrderNumbers | Get daily order numbers. |
GET /OrderStatistic/DailyOrderNumbers
Get daily order numbers.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
days | query | integer (int32) | No | Default: 7. |
Also accepts the shared list parameters.
Response: envelope; data is array of DailyOrderNumbersDto.