Specific Site

Statistics for a specific site

Changed on

Retrieves statistical data for a specific site

API key: requires the sites:read scope.

get/v1/sites/{siteId}/stats

Request

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

Path parameters

siteIdstring required

Site identifier

Response

Statistics retrieved successfully

siteIdstring

Site identifier

siteNamestring

Site name

totalConsumptionnumber

Total energy consumption in kWh

totalCostnumber

Total energy cost in GBP

totalEmissionsnumber

Total carbon emissions in kg CO2e

meterCountinteger

Number of meters at the site

periodstring

Reporting period

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's body type changed from no type to object for status

    7 more changes in this revision