Skip to main content
GET
/
api
/
v1
/
consumption
/
statistics
Get consumption statistics for current month
curl --request GET \
  --url https://api.raul.ugps.io/api/v1/consumption/statistics \
  --header 'Authorization: Bearer <token>'
{
  "totalConsumption": 125.5,
  "totalDownloadGb": 20.3,
  "totalUploadGb": 105.2,
  "avgPerDevice": 850.3,
  "devicesOverLimit": 5,
  "topRiskClients": [
    {
      "clientId": 1,
      "clientName": "Cliente ABC S.A.",
      "consumption": 1500.5,
      "expected": 1000,
      "percentageUsed": 150.05
    }
  ],
  "monthOverMonth": 12.5,
  "lastUpdated": "2026-01-15T10:30:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication

Response

​
totalConsumption
number
required

Consumo total en GB

Example:

125.5

​
totalDownloadGb
number
required

Total descarga (RX) en GB — datos recibidos por el dispositivo

Example:

20.3

​
totalUploadGb
number
required

Total subida (TX) en GB — datos enviados por el dispositivo (telemetría GPS)

Example:

105.2

​
avgPerDevice
number
required

Promedio de consumo por dispositivo en MB

Example:

850.3

​
devicesOverLimit
number
required

Cantidad de dispositivos que exceden el 100% del límite esperado

Example:

5

​
topRiskClients
object[]
required

Top 5 clientes en riesgo (>80% del límite)

​
monthOverMonth
number
required

Porcentaje de cambio vs mes anterior (negativo = reducción)

Example:

12.5

​
lastUpdated
string
required

Fecha y hora de última actualización (ISO 8601)

Example:

"2026-01-15T10:30:00Z"