PT EN

Indicadores de serviço

URL base: $BUSINESS_API

O objecto

yearinteger · opcional
quarterinteger · opcional
period_startstring (date-time) · opcional
period_endstring (date-time) · opcional
indicatorsarray of object · opcional
Mostrar atributos filhos
keystring · obrigatório

um de continuity_of_service, collection_efficiency, billing_efficiency, water_quality_compliance, staff_per_1000_connections

labelstring · obrigatório
unitstring · obrigatório
statusstring · obrigatório

um de ok, insufficient_data

valuenumber · obrigatório · anulável
formulastring · obrigatório
numeratornumber · obrigatório · anulável
denominatornumber · obrigatório · anulável
coveragestring · obrigatório
reasonstring · opcional
O objecto
{
  "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."
    }
  ]
}

Obter os indicadores de serviço

Registos

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.

Parâmetros

yearinteger · consulta · obrigatório

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

quarterinteger · consulta · opcional

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

staff_headcountinteger · consulta · opcional

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.

Devolve

200 OK

Mostrar atributos
yearinteger · opcional
quarterinteger · opcional
period_startstring (date-time) · opcional
period_endstring (date-time) · opcional
indicatorsarray of object · opcional
Mostrar atributos filhos
keystring · obrigatório

um de continuity_of_service, collection_efficiency, billing_efficiency, water_quality_compliance, staff_per_1000_connections

labelstring · obrigatório
unitstring · obrigatório
statusstring · obrigatório

um de ok, insufficient_data

valuenumber · obrigatório · anulável
formulastring · obrigatório
numeratornumber · obrigatório · anulável
denominatornumber · obrigatório · anulável
coveragestring · obrigatório
reasonstring · opcional

Erros 400 · 403

Permissões reports:read · Funções: admin, analyst, finance, owner

curl -X GET "$BUSINESS_API/service-indicators" \
  -H "Authorization: Bearer sk_test_..."
Resposta 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."
    }
  ]
}