IWA water balance for the whole system with per-DMA detail
LogsGET /water-balance
Computes the IWA water balance for the whole network over a window by balancing every DMA and adding up those with enough data; the response includes the per-DMA detail, system input, billed and unbilled authorised consumption, water losses and non-revenue water. DMAs with insufficient data are excluded from the totals with a warning, and the status is computed, partial_data or insufficient_data accordingly. Water losses are split into apparent and real only when apparent_loss_bp is given. Read-only; requires network read access.
Parameters
fromRequired start of the window as an RFC 3339 timestamp; the window must end after it and span at most 366 days.
toRequired end of the window as an RFC 3339 timestamp, later than from.
apparent_loss_bpOptional assumed apparent losses as basis points of authorised consumption, an integer from 0 to 10000 (100 = 1%); when omitted, losses are not split into apparent and real.
Returns
200 OK
Show attributes
scopeone of
system,dmadma_idperiod_startperiod_endstatusone of
computed,partial_data,insufficient_datasystem_input_litersbilled_authorized_litersunbilled_authorized_litersauthorized_consumption_literswater_losses_litersapparent_losses_litersreal_losses_litersloss_splitone of
computed_from_assumption,insufficient_dataapparent_loss_assumption_bpnon_revenue_water_litersnon_revenue_water_bpdmas_totaldmas_computeddmaswarnings
Permissions network:read · Roles: admin, analyst, field_reader, field_supervisor, operations, owner, viewer
curl -X GET "$BUSINESS_API/water-balance" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$BUSINESS_API/water-balance", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/water-balance",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/water-balance", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"scope": "system",
"dma_id": "dma_2gE3tiwbLQQnDGcrVkstPO8Bjkg",
"period_start": "2026-11-19T09:30:00Z",
"period_end": "2026-11-19T09:30:00Z",
"status": "computed",
"system_input_liters": 1,
"billed_authorized_liters": 1,
"unbilled_authorized_liters": 1,
"authorized_consumption_liters": 1342,
"water_losses_liters": 1,
"apparent_losses_liters": 1,
"real_losses_liters": 1,
"loss_split": "computed_from_assumption",
"apparent_loss_assumption_bp": 1,
"non_revenue_water_liters": 1,
"non_revenue_water_bp": 1,
"dmas_total": 125000,
"dmas_computed": 1,
"dmas": [],
"warnings": [
"warning"
]
}