Skip to main content
POST
/
api
/
v1
/
consumption
/
history
Get consumption history aggregated by month
curl --request POST \
  --url https://api.raul.ugps.io/api/v1/consumption/history \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startMonth": "2025-07",
  "endMonth": "2026-01"
}
'
[
  {
    "month": "2026-01",
    "totalConsumption": 125.5,
    "expectedConsumption": 100,
    "deviceCount": 120,
    "avgPerDevice": 1046,
    "overLimitCount": 5
  }
]

Authorizations

​
Authorization
string
header
required

Bearer token authentication

Body

application/json
​
startMonth
string

Mes inicial en formato YYYY-MM (opcional, default: hace 6 meses)

Example:

"2025-07"

​
endMonth
string

Mes final en formato YYYY-MM (opcional, default: mes actual)

Example:

"2026-01"

Response

​
month
string
required

Mes en formato YYYY-MM

Example:

"2026-01"

​
totalConsumption
number
required

Consumo total del mes en GB

Example:

125.5

​
expectedConsumption
number
required

Consumo esperado del mes en GB

Example:

100

​
deviceCount
number
required

Cantidad de dispositivos activos en el mes

Example:

120

​
avgPerDevice
number
required

Promedio de consumo por dispositivo en MB

Example:

1046

​
overLimitCount
number
required

Cantidad de dispositivos que excedieron el límite (>100%)

Example:

5