Skip to main content
GET
/
v1
/
sites
/
{siteId}
/
reports
Reports for a specific site
curl --request GET \
  --url https://api.voltview.co.uk/v1/sites/{siteId}/reports \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "<string>",
    "siteId": "<string>",
    "name": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "period": "<string>",
    "downloadUrl": "<string>"
  }
]

Authorizations

​
x-api-key
string
header
required

VoltView API key

Path Parameters

​
siteId
string
required

Site identifier

Response

Reports retrieved successfully

​
id
string

Report identifier

​
siteId
string

Site identifier

​
name
string

Report name

​
type
enum<string>

Report type

Available options:
CONSUMPTION,
COST,
EMISSIONS,
EFFICIENCY
​
createdAt
string<date-time>

Report creation date and time

​
period
string

Reporting period

​
downloadUrl
string<uri>

URL to download the report