Analysis APIs

Use Analysis APIs to calculate forecasted savings for solar PV, storage, tariff changes, and other energy scenarios in Switch.

Savings Analysis is the core Switch workflow. It compares scenarios, such as before solar, after solar, solar cost, and savings, then returns projected costs, usage, rates, and savings over the analysis period. Use Account Cost Calculation instead when you only need to calculate one account scenario.

Savings Analysis

Run savings analyses and review the request and response model, including scenarios, property inputs, rate inputs, and result series.

Savings Analysis History

Retrieve previously run savings analyses and optionally include the original request payload.

Data definitions

AccountAnalysis

An AccountAnalysis contains the results of a Savings Analysis. It includes summary values, scenario details, series metadata, and series data points for projected cost, usage, rates, and savings.

Field	Type	Description
`savingsAnalysisId`	String	Arcadia-generated ID for a saved Savings Analysis result.
`summary`	Object	First-year and lifetime cost, usage, rate, and savings totals.
`scenarios`	Array	Scenario definitions used in the analysis, such as `before`, `after`, `solar`, and `savings`.
`series`	Array	Metadata for each returned data series, including scenario, time frame, and granularity.
`seriesData`	Array	Data points for the returned series, including rate, quantity, and cost values.
`seriesCosts`	Object	Detailed cost calculations when `populateCosts=true`.

How these APIs fit together

Use Savings Analysis to run a new analysis for solar, storage, tariff changes, or other energy scenarios.
Use Savings Analysis Request Structure to choose propertyInputs patterns for profiles, typical baselines, solar, and storage.
Start from Helpful Request Templates when your use case matches Quick Switch, Full Switch, or Storage-in-Switch.
Use Savings Analysis History to retrieve analyses that were already run.

circle-info
Start with the Forecasted Savings Tutorial if you are preparing to run your first Savings Analysis. It walks through the setup needed before using these reference pages.

Next steps

Use Savings Analysis to run a new forecasted savings calculation.
Use Savings Analysis Request Templates when your workflow matches Quick Switch, Full Switch, or Storage-in-Switch.
Use Savings Analysis History to retrieve analyses that were already run.