Revenue by customer

Time	Status	User Agent
Make a request to see history.

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 report is associated with. If not specified, defaults to all programs.

programs

Show 32 enum values

ADD string

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.

Not supported for other aggregation types.

The search is case-insensitive and will match those results that start with the filter value. Passing multiple filters will

be applied as OR-condition. For example, passing [SCEC, PDRP] will match all records that start with either SCEC or PDRP.

filters
ADD string

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. When requesting a CSV format via Accept header with value text/csv, this parameter is not required.

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. When requesting a CSV format via Accept header with value 'text/csv', this parameter is not required.

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. Only supported for meter, customer_group and market_group types.

sort
ADD object

version
string
length ≥ 2
V.+

The report version. If not specified the latest version is returned.

`` 200 Retrieves periodic customer revenue reports for a specified time frame, with a request limit of up to 3 months.

object

customers
array of objects
required
The customer detail object.

customers*
object

customer_name
string
required
Customer Name

customer_group
string
The Customer Group(s) associated with the customer. If the customer is part of multiple groups, they will be separated by a comma.

meter_count
int32
required
The number of meters

nomination_w
double
required
Target quantity set for capacity market.

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

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

delivery_date
string
^\d{4}-\d{2}$

deprecated
ISO-8601 formatted year and month (YYYY-MM) representing the settlement delivery period date.

delivery_start_date
string
required
^\d{4}-\d{2}$

ISO-8601 formatted year and month (YYYY-MM) representing the settlement delivery period date.

delivery_end_date
string
required
^\d{4}-\d{2}$

ISO-8601 formatted year and month (YYYY-MM) representing the settlement delivery period 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 any bonuses, Leap adjustments like missed enrollment, and any adjustment payments if this report has multiple versions (V2, V3, etc.). In NY CSRP and DLRP adjustments also include any true up payments associated with updated performance factors from prior participation months

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

performance_adjustment
double
Any revenue changes applied to Capacity Revenue. Negative values reflect penalties, when capacity performance is below nominations. Positive values reflect aggregation benefits, where overperformance from one meter can offset underperformance elsewhere.

missed_revenue
double
The difference between potential revenue and the actual revenue of the revenue report over the settlement period. Rounded to zero if actual revenue is greater than potential revenue.

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

`` 400 Returns 400 if the request is invalid.

`` 401 Returns 401 if the request is unauthorized.

`` 403 Returns 403 if the request doesn't have the right values.

`` 415 Returns 415 if provided content in the request is not supported.

`` 500 Returns 500 if the there's an internal server error.

Updated 4 days ago

Base URL
https://api.staging.leap.energy/v1.1/revenue/periodic/aggregation/customer/search

xxxxxxxxxx

curl --request POST \

--url https://api.staging.leap.energy/v1.1/revenue/periodic/aggregation/customer/search \

--header 'accept: application/json' \

--header 'content-type: application/json' \

--data '{"page_size":100}'

{
  "customers": [
    {
      "customer_name": "John Doe",
      "customer_group": "Store Inc.",
      "meter_count": 10,
      "nomination_w": 16600.88,
      "capacity_revenue": 27600.3,
      "energy_revenue": 27600.3,
      "delivery_date": "",
      "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
    },
    {
      "customer_name": "John Doe",
      "customer_group": "Store Inc.",
      "meter_count": 10,
      "nomination_w": 16600.88,
      "capacity_revenue": 27600.3,
      "energy_revenue": 27600.3,
      "delivery_date": "",
      "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"
}