Products

Savings Analysis History APIs in Genability Switch

By

| Reading time 1 minute

Over the past few weeks we’ve introduced Switch API upgrades including Dash, a web-app to view and troubleshoot savings analyses, and Savings Analysis Watch, which automatically reviews Savings Analysis results for atypical results.

To complement these new features, you can now access information on historical savings analyses through the Savings Analysis History API, and on the results of the real-time data quality checks via the Savings Analysis Watch API.  This allows you to integrate all the functionality of Dash and Watch directly into your quote tool.

Savings Analysis History

The Savings Analysis History endpoint allows users to view historical savings analysis requests and results. Altogether, this provides an API through which you can see the evolution of a proposal for a potential customer.

Specifically, the Savings Analysis History endpoint lets you obtain historical calls for a particular account using one of the following requests:

GET /rest/v1/accounts/{accountId}/analyses ` GET /rest/v1/accounts/pid/{providerAccountId}/analyses`

Either of these requests will provide information on all Savings Analysis calls made for this account. You can also retrieve a particular Savings Analysis for an account:

GET /rest/v1/accounts/{accountId}/analyses/{savingsAnalysisId} ` GET /rest/v1/accounts/pid/{providerAccountId}/analyses/{savingsAnalysisId}`

These requests will return the unique identifier of the Savings Analysis call, the created date, and the summary information originally returned (e.g., preTotalCost, lifetimeSolarCost).

Savings Analysis Watch

Detailed in a recent blog post, Savings Analysis Watch is a tool that monitors the quality of Savings Analysis calls in real-time. While Dash offers a web-interface to view the Watch results, you can also query for the results via the Watch API for a single savings analysis call, or for multiple calls.

To view all Watch results for a particular savings analysis, use one of the following requests:

GET/rest/v1/accounts/{accountId}/analyses/{savingsAnalysisId}/watch/results/ ` GET/rest/v1/accounts/pid/{providerAccountId}/analyses/{savingsAnalysisId}/­watch/results/`

The requests will return the definition of the data quality check and the status of the Watch result (e.g., “Passed”).

The request to view Watch results for a set of savings analyses uses the following syntax:

GET /rest/v1/watch/results/{filters}

Where you can filter by utility, when the original Savings Analysis call was made, and status of the Watch result.

Using the New APIs

More information on how to integrate with the APIs is found in our Genability Developer Documentation on Savings Analysis History and Savings Analysis Watch. You can also contact us with questions.

Also in Products

Savings Analysis Watch - Monitoring the Quality of Your Proposals in Real-Time

By Ruben Garcia | May 4, 2016

Around 60,000 proposals for rooftop solar are expected to be generated per week in 2016. In the competitive landscape of distributed energy generation and storage, how can companies reasonably monitor the integrity of these proposals?

Genability Switch Dash Web UI

By Justin Lee | May 2, 2016

Switch Dash is a visual tool we developed to complement your origination platform and help guarantee that you are generating high quality proposals. This self service web-app takes the power of the Switch APIs and makes them...

Genability Switch Accuracy

By Tarpan Dixit | Apr 28, 2016

Genability Switch makes it easy to accurately forecast savings and avoided cost, even in markets with increasing regulatory and tariff complexity. With Switch V4, we’ve implemented multiple upgrades to ensure your proposals always reflect accurate solar savings....

Genability Switch Version 4

By Tarpan Dixit | Apr 18, 2016

We are proud to announce a series of exciting new upgrades to our flagship product, Switch. Switch is the market leading solution for providing residential solar customers with the most accurate savings forecasts.