Sites
Emissions

Annual consumption and emissions for all sites

Changed on

Retrieves annual energy consumption and emissions data across all sites

API key: requires the consumption:read scope.

get/v1/sites/annualConsumptionAndEmissions

Request

  • Base URL
    https://api.voltview.co.uk
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Response

Annual consumption and emissions data retrieved successfully

siteIdstring

Site identifier

periodstring

Reporting period

consumptionnumber

Energy consumption in kWh

emissionsnumber

Carbon emissions in kg CO2e

emissionsIntensitynumber

Emissions intensity in kg CO2e/kWh

comparisonPeriodstring

Previous period for comparison

previousConsumptionnumber

Previous period consumption in kWh

previousEmissionsnumber

Previous period emissions in kg CO2e

consumptionChangenumber

Percentage change in consumption

emissionsChangenumber

Percentage change in emissions

Changes

    • info

      the endpoint scheme security apiKeyAuth was added to the API

    • info

      the endpoint scheme security sessionJwt was added to the API

    • breaking

      the response property / became optional for the status

    2 more changes in this revision