api.dashboard.get

GET /dashboard — ACPortal

Python

api.dashboard.get(*, view_id: int | None = None, company_id: str | None = None) -> DashboardSummary

CLI

ab dashboard get [--view-id ...] [--company-id ...]

Aggregated dashboard summary for one grid view.

Both view_id and company_id are optional. When company_id is omitted the API defaults to the active user’s primary company — the call does not 4xx. view_id is the id of a row returned by :meth:get_grid_views.

Args: view_id: Grid view id (forward reference: :class:GridViewInfo.id). company_id: Company UUID; defaults to the caller’s primary company.

Query parameters — DashboardParams

Field	Type	Required	Description
viewId	Optional[int]	no	Grid view ID
companyId	Optional[str]	no	Company UUID filter

Response

Returns DashboardSummary.

Field	Type	Required	Description
inboundCount	Optional[int]	no	Inbound shipment count
outboundCount	Optional[int]	no	Outbound shipment count
inHouseCount	Optional[int]	no	In-house shipment count
localDeliveriesCount	Optional[int]	no	Local delivery count
recentEstimatesCount	Optional[int]	no	Recent estimates count
data	Optional[list[DashboardItem]]	no	Grid view rows

---

← Back to api.dashboard