Skip to main content
GET
/
v1
/
sites
/
{siteId}
/
stats
Statistics for a specific site
curl --request GET \
  --url https://api.voltview.co.uk/v1/sites/{siteId}/stats \
  --header 'x-api-key: <api-key>'
{
  "siteId": "<string>",
  "siteName": "<string>",
  "totalConsumption": 123,
  "totalCost": 123,
  "totalEmissions": 123,
  "meterCount": 123,
  "period": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.voltview.co.uk/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

VoltView API key

Path Parameters

siteId
string
required

Site identifier

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