GET
/
v1
/
sites
/
{siteId}
/
emissions
curl --request GET \
  --url https://api.voltview.co.uk/v1/sites/{siteId}/emissions \
  --header 'Authorization: Bearer <token>'
{
  "siteId": "<string>",
  "period": "<string>",
  "emissions": 123,
  "emissionsIntensity": 123,
  "emissionsBySource": {
    "electricity": 123,
    "gas": 123,
    "other": 123
  },
  "historicalData": [
    {
      "period": "<string>",
      "emissions": 123
    }
  ],
  "carbonSavings": 123,
  "targetReduction": 123
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from /v1/requestToken endpoint

Path Parameters

​
siteId
string
required

Site identifier

Query Parameters

​
lookback
string

Time period to look back (e.g. 1d, 1w, 1m, 1y for day, week, month, year)

Example:

"1y"

Response

200
application/json
Emissions data retrieved successfully
​
siteId
string
required

Site identifier

​
emissions
number
required

Carbon emissions in kg CO2e

​
period
string

Reporting period

​
emissionsIntensity
number

Emissions intensity in kg CO2e/kWh

​
emissionsBySource
object

Breakdown of emissions by source

​
historicalData
object[]

Historical emissions data for comparison

​
carbonSavings
number

Carbon savings compared to baseline in kg CO2e

​
targetReduction
number

Target reduction percentage