Use common propertyInputs patterns to structure Savings Analysis requests for usage profiles, typical baselines, solar production, and storage optimization.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Use common propertyInputs patterns to structure Savings Analysis requests for usage profiles, typical baselines, solar production, and storage optimization.
Each propertyInputs object identifies an input with keyName, supplies its value with dataValue, and usually specifies the scenario or scenarios where the input applies with scenarios.
For the full request model, response model, and examples, see Savings Analysis. For the full analysis workflow, see Analysis APIs.
Resource URI
POST /rest/v1/accounts/analysisCommon request body fields
| Field | Type | Description |
|---|---|---|
accountId | String | Arcadia-generated account ID. Pass either accountId or providerAccountId. Optional. |
providerAccountId | String | Your account ID. Pass either accountId or providerAccountId. Optional. |
fromDateTime | DateTime | Start of the analysis. Set this to the first day of the month to return 12 monthly values for the first-year series. Required. |
propertyInputs | Array | Scenario inputs for usage profiles, typical baselines, solar production, storage optimization, rate inflation, degradation, and other assumptions. Optional. |
rateInputs | Array | Custom tariff rates for the analysis, such as lease rates, PPA rates, or special tax rates. Optional. |
populateCosts | Boolean | When true, includes a more detailed breakdown of first-year calculation results. Defaults to false. Optional. |
tariffEffectiveOn | Date | Use one specific tariff version for the analysis. Optional. |
autoBaseline | Boolean | Enables intelligent baselining. Defaults to true. Optional. |
useIntelligentBaselining | Boolean | Controls interpolation and extrapolation when intelligent baselining is enabled. Optional. |
batteryDegradation | Object | Battery degradation settings for savings projections from year two onward. Optional. |
Common propertyInputs objects
propertyInputs objectsUser-created profile by profileId
profileIdUse profileId when you want to reference a profile by its Arcadia-generated UUID.
{
"keyName": "profileId",
"dataValue": "676065b0fead7732016d4f85"
}User-created profile by providerProfileId
providerProfileIdUse providerProfileId when you want to reference a profile by your own custom identifier.
{
"keyName": "providerProfileId",
"dataValue": "site-194853-usage-2025"
}Arcadia usage typical baseline by baselineType
baselineTypeUse typicalElectricity when you want Switch to use Arcadia Typical Baseline data for electricity usage.
{
"keyName": "baselineType",
"dataType": "STRING",
"dataValue": "typicalElectricity",
"scenarios": "before,after"
}Arcadia solar production typical baseline by baselineType
baselineTypeUse typicalSolarPv when you want Switch to use Arcadia Typical Baseline data for solar production. The operator is commonly set to - when solar production offsets after-solar utility consumption.
{
"keyName": "baselineType",
"dataType": "STRING",
"dataValue": "typicalSolarPv",
"scenarios": "after,solar",
"operator": "-"
}Arcadia storage optimization profile by storageProviderProfileId
storageProviderProfileIdUse storageProviderProfileId to reference the generated profile set from the Storage Profile endpoint. This value maps to the generated -usage, -solar, and -storage profiles.
{
"keyName": "storageProviderProfileId",
"dataValue": "sins-example-storage-ppid-2025",
"scenarios": "after,solar"
}Your
scenariosandoperatorvalues may differ from these examples depending on the analysis type. Use these snippets as request-structure guidance, then confirm scenario behavior in Savings Analysis.
Next steps
- Return to Analysis APIs to choose another analysis workflow.
- Use Savings Analysis Request Templates to start from a complete request body.
- Use Savings Analysis to review the full request and response model.
