Energy Consumption

Time series data for a specific site

Changed on

Retrieves time series energy data for a specific site

Scoped API keys require consumption:read and effective site access.

API key: requires the consumption:read scope.

get/v1/sites/{siteId}/timeSeries

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

Query parameters

granularity'hour' | 'day' | 'month' | 'year'

Data aggregation granularity

fromstring date-time
Example:2024-01-01T00:00:00.000Z

Start date and time (ISO 8601)

tostring date-time
Example:2024-12-31T23:59:59.999Z

End date and time (ISO 8601)

unit'kWh' | 'kW'

Unit of measurement

Response

Time series data retrieved successfully

siteIdstring

Site identifier

granularitystring

Data granularity

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

    5 more changes in this revision