Skip to main content
GET
/
v1
/
sites
/
{siteId}
/
timeSeries
Time series data for a specific site
curl --request GET \
  --url https://api.voltview.co.uk/v1/sites/{siteId}/timeSeries \
  --header 'x-api-key: <api-key>'
{
  "siteId": "<string>",
  "granularity": "<string>",
  "data": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "value": 123,
      "unit": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

VoltView API key

Path Parameters

​
siteId
string
required

Site identifier

Query Parameters

​
granularity
enum<string>

Data aggregation granularity

Available options:
hour,
day,
month,
year
​
from
string<date-time>

Start date and time (ISO 8601)

Example:

"2024-01-01T00:00:00.000Z"

​
to
string<date-time>

End date and time (ISO 8601)

Example:

"2024-12-31T23:59:59.999Z"

​
unit
enum<string>

Unit of measurement

Available options:
kWh,
kW

Response

Time series data retrieved successfully

​
siteId
string

Site identifier

​
granularity
string

Data granularity

​
data
object[]