Skip to main content

Aggregate a dataset over a resolution window and apply a function.

Aggregation operations

  • sum: Add up all values in each resolution window
  • mean: Take the mean - average - of all values in each resolution window
  • max: Take the maximum value in each resolution window
  • min: Take the minimum value in each resolution window
​
aggregation_function
enum<string>
required

Aggregation function to apply.

Available options:
sum,
mean,
max,
min
​
input
Dataset · object
required

Dataset to aggregate

Example:
{
  "id": "quarter-hourly-energy-offtake",
  "resolution": "quarter_hourly",
  "unit": "kWh"
}
​
output
Dataset · object
required

Output Dataset, the result of applying the specified aggregation function to the input dataset in windows of the given resolution

Example:
{
  "id": "quarter-hourly-energy-offtake",
  "resolution": "quarter_hourly",
  "unit": "kWh"
}
​
resolution
enum<string>
required

Window over which to aggregate.

Available options:
quarter_hourly,
hourly,
daily,
weekly,
monthly,
yearly
​
function
string
default:aggregate
Allowed value: "aggregate"