Filter Period KPIs

post http://localhost:8080/v2/emissions/period/kpis

Returns KPIs for Emissions, Total Fuel, Total Emissions, Total Usage Hours, Total kWh, Fuel Compilation, Emissions Compilation, Usage Hours Compilation, kWh Compilation, Average Emissions, Average Emissions by Usage Hours, Different Power Types, grouped by asset types

➡️
OpenAPI Specification for the Emissions API domain
Get the OpenAPI Specification (formerly Swagger), which is a standardized format that describes the functionalities, endpoints, parameters, and data models of this API in a JSON file here.

Responses

Response body

object

content

object

The list of Emissions KPIs

totalFuel

double

The total amount of fuel used by all assets for the given group

totalEmissions

double

The total amount of emissions calculated for all assets over their operational lifetime for the given group

totalUsageHours

double

The total amount of usage hours by all assets for the given group

totalKwh

double

The total amount of kWh by all assets for the given group

fuelCompilation

array of objects

The calculated fuel summed by each group

fuelCompilation

object

name

string

The name of the grouped data

value

double

The total value of the grouped calculated data

emissionsCompilation

array of objects

The calculated emissions summed by each group

emissionsCompilation

object

name

string

The name of the grouped data

value

double

The total value of the grouped calculated data

usageHoursCompilation

array of objects

The total usage hours summed by each group

usageHoursCompilation

object

name

string

The name of the grouped data

value

double

The total value of the grouped calculated data

kwhCompilation

array of objects

The total kWh summed by each group

kwhCompilation

object

name

string

The name of the grouped data

value

double

The total value of the grouped calculated data

averageEmissionsTotal

array of objects

The average emissions for each group

averageEmissionsTotal

object

name

string

The name of the grouped data

value

double

The total value of the grouped calculated data

averageEmissionsByUsageHours

array of objects

The average emissions by usage hours for each group

averageEmissionsByUsageHours

object

name

string

The name of the grouped data

value

double

The total value of the grouped calculated data

powerTypes

array of objects

The total power types

powerTypes

object

name

string

Name of the power type

value

int32

The number of power types in the group

averageDataSourceScore

double

The average data source score for the given group

dataSourceScoreCompilation

object

The count of each data source score for the given group

emissionsChangePercent

double

The change in percent compared to the last period for emissions

fuelUsageChangePercent

double

The change in percent compared to the last period for fuel usage

usageHoursChangePercent

double

The change in percent compared to the last period for usage hours

kwhChangePercent

double

The change in percent compared to the last period for kWh

countryCount

array of objects

The list of countries and count of assets in each

countryCount

object

name

string

The name of the grouped data

value

int32

The total value of the grouped calculated data

fuelTypeCount

array of objects

The list of fuel types and count of assets in each

fuelTypeCount

object

name

string

The name of the grouped data

value

int32

The total value of the grouped calculated data

➡️OpenAPI Specification for the Emissions API domain

200Returns KPIs for Emissions, Total Fuel, Total Emissions, Total Usage Hours, Total kWh, Fuel Compilation, Emissions Compilation, Usage Hours Compilation, kWh Compilation, Average Emissions, Average Emissions by Usage Hours, Different Power Types, grouped by asset types

400Bad request

401Invalid or missing bearer token in Authorization header

403User not allowed to make this request

404Resource not found

500Internal server error

➡️
OpenAPI Specification for the Emissions API domain