Skip to main content
GET
Comparison of the annual electricity consumption of similar households

Path Parameters

site-id
string
required

Site identifier

Query Parameters

begin-year
string
required

Year of the beginning of the comparison

Response

Successful response

year
integer
required

Year on which the comparison was made. format YYYY

Example:

2021

beginMonth
string
required

Month of the beginning of the comparison. format YYYY-MM

Example:

"2021-01"

endMonth
string
required

Month (included) of the end of the comparison on the year. format YYYY-MM

Example:

"2021-08"

energies
object
required

The yearly consumption power comparison (in KWh) between the site and the similar households

percentComparison
object
required
Example:
costs
object

The yearly consumption cost comparison between the site and the similar households

fromDate
string

begin date of the comparison (format YYYY-MM-JJ)

Example:

"2021-01-01"

toDate
string

end date of the comparison (the date is included, format YYYY-MM-JJ)

Example:

"2021-08-05"

comparisonCriteria
object

Map of the criteria used in comparison

Example: