HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Savings Analysis Request Templates

Use these Savings Analysis request templates to start from common Switch workflows before customizing your scenarios, property inputs, and rate inputs.

Use these Savings Analysis request templates to start from common Switch workflows before customizing your scenarios, property inputs, and rate inputs.

Choose the template that matches the data you have available. Use Quick Switch when you want Arcadia Typical Baseline data, Full Switch when you have user-supplied usage or solar profiles, and Storage-in-Switch when you have generated post-storage profiles. For the full analysis workflow, see Analysis APIs.

When to use each template

TemplateUse whenPrimary profile source
Quick Switch Request TemplateYou do not have real-world usage or solar production profiles.Arcadia Typical Baselines
Full Switch Request TemplateYou have customer-supplied usage or solar production profiles.Profiles
Storage-in-Switch Request TemplateYou have generated post-storage profiles from the Storage Profile endpoint.Storage Profiles

For the full request and response model, see Savings Analysis. For common propertyInputs patterns, see Savings Analysis Request Structure.

Next steps

  1. Return to Analysis APIs to choose another analysis workflow.
  2. Use Savings Analysis Request Structure to adapt a template to your own scenarios.
  3. Use Savings Analysis to review the full request and response model.