Skip to main content
GET
/
v1
/
sites
/
stats
Statistics for all sites
curl --request GET \
  --url https://api.voltview.co.uk/v1/sites/stats \
  --header 'Authorization: Bearer <token>'
[
  {
    "siteId": "<string>",
    "siteName": "<string>",
    "totalConsumption": 123,
    "totalCost": 123,
    "totalEmissions": 123,
    "meterCount": 123,
    "period": "<string>"
  }
]

Authorizations

Authorization
string
header
required

Supabase Auth JWT access token obtained after signing in via magic link or OTP

Response

Statistics retrieved successfully

siteId
string

Site identifier

siteName
string

Site name

totalConsumption
number

Total energy consumption in kWh

totalCost
number

Total energy cost in GBP

totalEmissions
number

Total carbon emissions in kg CO2e

meterCount
integer

Number of meters at the site

period
string

Reporting period