Developer Guides

Revenue Data

Suggest Edits

🚧

Beta

The Revenue API is currently in beta. There may be changes prior to general availability.


The Revenue API provides a set of endpoints for partners to access revenue data that has been earned by participating in grid services programs with Leap. Accessing preliminary and final revenue data in a timely manner helps increase efficiency as well as more quickly identify opportunities to improve revenue.

Retrieve monthly customer revenue data

The monthly revenue data endpoints provide revenue data per program, meter, market group, customer, utility, or load type and can be used to accomplish the following:

  • Understand how revenue is generated within your portfolio filtering by program, meter, market group, customer, utility, or load type
  • Leverage preliminary estimates and final revenue data for customer reporting and payments (if applicable for your grid services offering)

Track missed revenue & flag worst performing meters

The worst performing meters in your portfolio can significantly impact overall revenue. Prioritize investigation and corrective action on these meters by leveraging the revenue by meter endpoint and automating the following steps:

  1. Query for each applicable month and program
  2. For each meter_id, confirm data_coverage_percentage:
    • If greater than 75%, proceed with calculation below
    • If less than 75%, skip analysis for this meter until data coverage reaches threshold
  3. Calculate Missed Revenue:
    • Missed Revenue = potential_revenue - total_revenue
    • % Missed Revenue = (potential_revenue - total_revenue) / potential_revenue
  4. Flag worst performing meters (based on above calculations) for follow-up to confirm event response and no hardware or software issues
    • If meters correctly responded to all events, reach out to your Leap partner success manager for further analysis and nominations discussion

Automate revenue and settlement reporting

To eliminate operations overhead and the risk of human errors, monthly and seasonal settlement reporting can be automated to accomplish the following:

  • Retrieve final revenue report data and format for finance team analysis
  • Sync revenue data with financial systems for automated reporting, analysis, and tracking trends
  • Track revenue report version changes

These use cases are supported by the following endpoints:

Updated 4 days ago