URL Expired

The URL for this request expired after 30 days.

The request body containing aggregation detail.

Search for aggregations in a specific period. Max allowed period between start and end is 3 months.

period_start
string
required
^\d{4}-\d{2}$
The start of the period for the report in ISO-8601 formatted year and month (YYYY-MM).

period_end
string
required
^\d{4}-\d{2}$
The end of the period for the report in ISO 8601 format (YYYY-MM), which is inclusive.

programs
array of objects
The list of the program identifiers that the report is associated with. If not specified, defaults to all programs.

filters
array of strings
Optional filters to apply to the search query. Depending on the aggregation type, the filters are applied to the following field:

• METER: meter ID,
• MARKET_GROUP: market group ID,
• CUSTOMER: customer name.

The search is case-insensitive and will match those results that start with the filter value. Passing multiple filters will be applied as an OR-condition. For example, passing ["SCEC", "PDRP"] will match all records that start with either SCEC or PDRP.

page_token
string
If there are more records to fetch, this token will be populated as next_page_token in the response. Use it to fetch the next page.

page_size
int32
required
Defaults to 100
Specifies the number of results to return. Defaults to 100 if not set, with a maximum limit of 1000 per page.

sort
array of objects
Specifies the sorting criteria for the results. It is a list of fields by which the results should be sorted. This parameter is optional.

version
string
length ≥ 2
V.+
The report version. If not specified, the latest version is returned.

Responses

200

Retrieves periodic load type revenue reports for a specified time frame, with a request limit of up to 3 months.

load_types
array of objects
required
The load type detail object.

load_types
object
load_type
string
enum
required
Load type
HVAC, EV_CHARGING, BATTERY_STORAGE, COLD_STORAGE, PUMPING, WATER_HEATING, BUILDING_AUTOMATION, GENERATION, MANUFACTURING, LIGHTING, OTHER, UNASSIGNED_LOAD_TYPE

meter_count
int32
required
The number of meters.

nomination_w
double
Target quantity set for capacity market.

capacity_revenue
double
required
Revenue received by the partner for participating in the capacity market.

energy_revenue
double
required
Revenue received by the partner for actively participating in energy programs.

delivery_start_date
string
required
^\d{4}-\d{2}$
ISO-8601 formatted year and month (YYYY-MM) representing the settlement delivery period start date.

delivery_end_date
string
required
^\d{4}-\d{2}$
ISO-8601 formatted year and month (YYYY-MM) representing the settlement delivery period end date.

monetized_w
double
Monetized capacity wattage. Partners provide nomination and then Leap will calculate what capacity can be monetized based on program rules.

total_revenue
double
required
Total revenue.

capacity_performance_percentage
double
Capacity performance percentage.

energy_performance_percentage
double
Energy performance percentage.

data_coverage_percentage
double
Data coverage percentage.

energy_earned_wh
double
Energy earned watt hour.

potential_revenue
double
Potential revenue if performance reached 100%.

capacity_earned_w
double
Capacity earned wattage.

payment_adjustment
double
A sum of bonuses and any adjustments (if this report has multiple versions).

penalty
double
The sum of all penalties or market adjustments applied to the revenue.

performance_adjustment
double
Revenue changes applied to Capacity Revenue. Negative values reflect penalties; positive values reflect benefits.

missed_revenue
double
The difference between potential revenue and actual revenue for the settlement period.

version
string
length ≥ 2
V.+
The report version. If not specified, the latest version is returned.

capacity_price
double
Capacity price.

energy_price_kwh
double
Energy price.

Example Request

curl --request POST \
     --url https://api.staging.leap.energy/v1.1/revenue/periodic/aggregation/load-type/search \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"page_size":100}'

Example Response

{
  "load_types": [
    {
      "load_type": "BATTERY_STORAGE",
      "meter_count": 10,
      "nomination_w": 16600.88,
      "capacity_revenue": 27600.3,
      "energy_revenue": 27600.3,
      "delivery_start_date": "2023-03",
      "delivery_end_date": "2023-03",
      "monetized_w": 8400,
      "total_revenue": 20600.3,
      "capacity_performance_percentage": 50.33,
      "energy_performance_percentage": 60.5,
      "data_coverage_percentage": 55.5,
      "energy_earned_wh": 2000.3,
      "potential_revenue": 104366.8,
      "capacity_earned_w": 2000.3,
      "payment_adjustment": 20,
      "penalty": 11,
      "performance_adjustment": 12,
      "missed_revenue": 20000.3,
      "version": "V1",
      "capacity_price": 5.56,
      "energy_price_kwh": 6.67
    }
  ],
  "page_token": "page_token"
}