Skip to main content

Operational KPIs

GET 
/api/v2/dashboard/operational-kpis

Returns operational KPI metrics for the dashboard.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Requires Bearer token.

Users without financials.index still get every count and alert, but the dollar amounts are hidden: pos_arriving.inbound_value is null with pos_arriving.inbound_value_hidden_reason = "Amount hidden — needs the "Financials → List" permission", and the detail line of money-valued Needs Attention alerts (financial-alert loss, overdue vendor-deposit total) is replaced by that same text.

Keys under data: low_stock {count, critically_low}, backorders {count, total_units}, unfulfilled_orders {count, past_ship_by_date}, pos_arriving {count, inbound_value}, ap_due {overdue, due_soon}, ar_overdue {amount, count}, stranded_orders {count, oldest_days}, releasable_backorders {count, units, orders}, inventory_debt {claims, units, clearing_balance, oldest_age_days} and needs_attention (alert list).

releasable_backorders — backorders whose stock is already on hand at their warehouse. count is how many backorder allocations the available stock can actually cover, orders how many orders they belong to, and units the quantity a release would actually move: each backorder's quantity capped by the stock left after the backorders ahead of it. Three 6-unit backorders on 9 units in stock report count: 2, units: 9 (6 + 3), not the backorders' full 12.

Request​

Responses​

OK