Dashboard

class ab.api.endpoints.dashboard.DashboardEndpoint(client)

Dashboard operations (ACPortal API).

Parameters:

client (HttpClient)

get(*, view_id=None, company_id=None)

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 get_grid_views().

Parameters:

• view_id (int | None) – Grid view id (forward reference: GridViewInfo.id).

• company_id (str | None) – Company UUID; defaults to the caller’s primary company.

Return type:

DashboardSummary

Docs: https://ab-sdk.readthedocs.io/en/latest/api/dashboard/get.html Query params: DashboardParams Response model: DashboardSummary

get_grid_views()

List the grid views available to the caller.

Each row carries the id you pass to get() as view_id, plus name, dataKey, and isActive.

Docs: https://ab-sdk.readthedocs.io/en/latest/api/dashboard/get_grid_views.html Query params: DashboardCompanyParams Response model: List[GridViewInfo]

Return type:

list[GridViewInfo]

get_grid_view_state(view_id)

Fetch the saved column / filter / sort state for a grid view.

Docs: https://ab-sdk.readthedocs.io/en/latest/api/dashboard/get_grid_view_state.html Response model: GridViewState

Parameters:

view_id (str)

Return type:

GridViewState

save_grid_view_state(view_id, *, data)

POST /dashboard/gridviewstate/{id}.

Parameters:

• view_id (str) – View state identifier.

• data (GridViewState | dict) – Grid view state with columns, filters, and sort_order. Accepts a GridViewState instance or a dict.

Return type:

None

Request model: GridViewState

Docs: https://ab-sdk.readthedocs.io/en/latest/api/dashboard/save_grid_view_state.html Request model: GridViewState

inbound(*, data)

POST /dashboard/inbound.

Parameters:

data (DashboardCompanyRequest | dict) – Dashboard company filter payload. Accepts a DashboardCompanyRequest instance or a dict.

Return type:

None

Request model: DashboardCompanyRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/dashboard/inbound.html Request model: DashboardCompanyRequest

in_house(*, data)

POST /dashboard/inhouse.

Parameters:

data (DashboardCompanyRequest | dict) – Dashboard company filter payload. Accepts a DashboardCompanyRequest instance or a dict.

Return type:

None

Request model: DashboardCompanyRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/dashboard/in_house.html Request model: DashboardCompanyRequest

outbound(*, data)

POST /dashboard/outbound.

Parameters:

data (DashboardCompanyRequest | dict) – Dashboard company filter payload. Accepts a DashboardCompanyRequest instance or a dict.

Return type:

None

Request model: DashboardCompanyRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/dashboard/outbound.html Request model: DashboardCompanyRequest

local_deliveries(*, data)

POST /dashboard/local-deliveries.

Parameters:

data (DashboardCompanyRequest | dict) – Dashboard company filter payload. Accepts a DashboardCompanyRequest instance or a dict.

Return type:

None

Request model: DashboardCompanyRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/dashboard/local_deliveries.html Request model: DashboardCompanyRequest

recent_estimates(*, data)

POST /dashboard/recentestimates.

Parameters:

data (DashboardCompanyRequest | dict) – Dashboard company filter payload. Accepts a DashboardCompanyRequest instance or a dict.

Return type:

None

Request model: DashboardCompanyRequest

Docs: https://ab-sdk.readthedocs.io/en/latest/api/dashboard/recent_estimates.html Request model: DashboardCompanyRequest

Per-endpoint reference

Each route-backed method has its own page rendering the HTTP route, the Python and CLI call signatures, and the request/response model field tables. This is the page help(api.dashboard.<method>) links to via its Docs: footer. These pages are generated by scripts/generate_endpoint_docs.py and kept current by a CI freshness gate.

• api.dashboard.get
• api.dashboard.get_grid_view_state
• api.dashboard.get_grid_views
• api.dashboard.in_house
• api.dashboard.inbound
• api.dashboard.local_deliveries
• api.dashboard.outbound
• api.dashboard.recent_estimates
• api.dashboard.save_grid_view_state

Methods

get

GET /dashboard — Aggregated dashboard summary.

Returns: DashboardSummary

summary = api.dashboard.get()
print(summary.inbound_count, summary.outbound_count)

get_grid_views

GET /dashboard/gridviews — List available grid views.

Returns: list[GridViewInfo]`

get_grid_view_state / save_grid_view_state

GET/POST /dashboard/gridviewstate/{id} — Read/save grid view state.

Returns: GridViewState

inbound / in_house / outbound / local_deliveries / recent_estimates

POST /dashboard/{panel} — Operational panel data.

data = api.dashboard.inbound()