Service indicators

Base URL: $BUSINESS_API

The object

yearinteger · optional
quarterinteger · optional
period_startstring (date-time) · optional
period_endstring (date-time) · optional
indicatorsarray of object · optional
Show child attributes
keystring · required

one of continuity_of_service, collection_efficiency, billing_efficiency, water_quality_compliance, staff_per_1000_connections

labelstring · required
unitstring · required
statusstring · required

one of ok, insufficient_data

valuenumber · required · nullable
formulastring · required
numeratornumber · required · nullable
denominatornumber · required · nullable
coveragestring · required
reasonstring · optional
The object
{
  "year": 1,
  "quarter": 1,
  "period_start": "2026-11-19T09:30:00Z",
  "period_end": "2026-11-19T09:30:00Z",
  "indicators": [
    {
      "key": "continuity_of_service",
      "label": "label",
      "unit": "unit",
      "status": "ok",
      "value": 13.42,
      "formula": "formula",
      "numerator": 1,
      "denominator": 1,
      "coverage": "coverage",
      "reason": "Leitura confirmada no local."
    }
  ]
}

Utility service indicators for operational, commercial

Logs

GET /service-indicators

Utility service indicators for operational, commercial, and water-quality performance over a year or quarter, with formulas and data coverage

Computes the tenant's service performance indicators for a year or one quarter: continuity of service, collection efficiency, billing efficiency, water quality compliance and staff per 1,000 active connections. Each indicator carries its formula, numerator, denominator and coverage, or the reason it could not be computed. A period still running is cut at the current time, and a period that has not started returns 400. Requires reports:read.

Parameters

yearinteger · query · required

Required calendar year to report on, from 2000 to 2100.

quarterinteger · query · optional

Optional quarter of the year, 1 to 4; when omitted the whole year is reported.

staff_headcountinteger · query · optional

Optional staff headcount for the period, a whole number of 0 or more, used only for the staff per 1,000 active connections indicator; without it that indicator is reported as missing.

Returns

200 OK

Show attributes
yearinteger · optional
quarterinteger · optional
period_startstring (date-time) · optional
period_endstring (date-time) · optional
indicatorsarray of object · optional
Show child attributes
keystring · required

one of continuity_of_service, collection_efficiency, billing_efficiency, water_quality_compliance, staff_per_1000_connections

labelstring · required
unitstring · required
statusstring · required

one of ok, insufficient_data

valuenumber · required · nullable
formulastring · required
numeratornumber · required · nullable
denominatornumber · required · nullable
coveragestring · required
reasonstring · optional

Errors 400 · 403

Permissions reports:read · Roles: admin, analyst, finance, owner

curl -X GET "$BUSINESS_API/service-indicators" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "year": 1,
  "quarter": 1,
  "period_start": "2026-11-19T09:30:00Z",
  "period_end": "2026-11-19T09:30:00Z",
  "indicators": [
    {
      "key": "continuity_of_service",
      "label": "label",
      "unit": "unit",
      "status": "ok",
      "value": 13.42,
      "formula": "formula",
      "numerator": 1,
      "denominator": 1,
      "coverage": "coverage",
      "reason": "Leitura confirmada no local."
    }
  ]
}