Skip to content

[GET] consumption

/api/graphs/consumption

ConsumptionGraphRequestDTO

Attributes:

Name Type Description
site_id int

int

start datetime

ISO format datetime

end datetime

ISO format datetime

graph_type str

'line' or 'bar'

ConsumptionGraphResponseDTO

Attributes:

Name Type Description
consumption_data list

List of lists of graph data

order list

list of how the graph data and other statistical results are arranged

statistics ConsumptionGraphStatisticsDTO

power or energy statistics based on the date range chosen

ConsumptionGraphStatisticsDTO

Attributes:

Name Type Description
total_energy list

list of total energies arranged based on the response's order

peak_value list

list of peak values of energy or power depending on the graph type arranged based on the order

peak_time list

list of datetime values of when the peak occurred. Values are mapped to the peak value list

load_factor list

list of load factor values arranged based on the order

latest list

list of latest energy or power reading arranged based on the order

average_peak list

list of average peak values arranged based on order