Summary:
These metric updates refer to the Data Access Layer. The DAL is a powerful, yet simple endpoint to pull data from jobs. Please click here to find a full overview and explanation.
Sprint 2.15 - 12/21/17
Metrics removed:
'credit_expiration_date',
'credit_last_updated',
'credit_qualification_amount_approved',
'credit_qualification_amount_approved_override',
'credit_qualification_application_status',
'credit_qualification_date_updated',
'credit_qualification_decision_status',
'credit_qualification_external_id',
'credit_qualification_id',
'credit_qualification_is_active',
'credit_qualification_modified_by',
'credit_qualification_status',
'credit_status_for_job',
'external_ids',
'legal_contact_applicant_type',
'legal_contact_date_updated',
'property_expiration_date',
'qualification_credit_qualification_external_id',
'qualification_status',
'title_expiration_date'
Metrics Added:
Key:
Stage must be either ‘pre’ or ‘regular’
Category must be ‘credit’, ‘title’, ‘property’
Order must be a number greater than 0
'[stage]_[category]_address_address_line_1',
'[stage]_[category]_address_city_name',
'[stage]_[category]_address_county_name',
'[stage]_[category]_address_formal',
'[stage]_[category]_address_id',
'[stage]_[category]_address_property_type',
'[stage]_[category]_address_state_abbreviation',
'[stage]_[category]_address_trust_name',
'[stage]_[category]_address_vesting_code',
'[stage]_[category]_address_zipcode',
'[stage]_[category]_application_date_initiated',
'[stage]_[category]_application_date_submitted',
'[stage]_[category]_application_external_id',
'[stage]_[category]_application_id',
'[stage]_[category]_application_status',
'[stage]_[category]_contact_applicant_type_[order]',
'[stage]_[category]_contact_date_updated_[order]',
'[stage]_[category]_contact_email_[order]',
'[stage]_[category]_contact_id_[order]',
'[stage]_[category]_contact_name_[order]',
'[stage]_[category]_contact_phone_number_[order]',
'[stage]_[category]_product_result_date_updated',
'[stage]_[category]_product_result_expiration_date',
'[stage]_[category]_product_result_id',
'[stage]_[category]_product_result_max_amount_approved',
'[stage]_[category]_product_result_modified_by',
'[stage]_[category]_product_result_product_id',
'[stage]_[category]_product_result_status',
'[stage]_[category]_scorecard_amount_approved_usd',
'[stage]_[category]_scorecard_decision',
'[stage]_[category]_scorecard_decision_date',
'[stage]_[category]_scorecard_id',
'[stage]_[category]_scorecard_name',
'address_elevation',
'address_latitude',
'address_longitude',
'buydown_amount',
'buydown_month',
'financing_fees',
'legal_contact_phone_number_[order]', > new following same logic as updated legal contact metrics below
'legal_site_property_type', > new legal site metric following same format as updated ones below
'legal_site_trust_name', > new legal site metric following same format as updated ones below
'legal_site_vesting_code', > new legal site metric following same format as updated ones below
'monthly_payment_buydown',
'monthly_payment_secondary',
'ongoing_interest_and_fees_total',
'product_result_date_updated', > only useful for reports, TBD if will remain public
'product_result_expiration_date', > only useful for reports, TBD if will remain public
'product_result_id', > only useful for reports, TBD if will remain public
'product_result_max_amount_approved', > only useful for reports, TBD if will remain public
'product_result_modified_by', > only useful for reports, TBD if will remain public
'product_result_product_id', > only useful for reports, TBD if will remain public
'product_result_qualification_id', > only useful for reports, TBD if will remain public
'product_result_site_id', > only useful for reports, TBD if will remain public
'product_result_status', > only useful for reports, TBD if will remain public
'qualification_id', > Top level qualification object attached to solarsite
'quote_[stage]_[category]_product_result_amount_approved', > active product result for quote
'quote_[stage]_[category]_product_result_status', > active product result for quote
'quote_channel_manager_id',
'quote_channel_manager_name',
'quote_financier_id',
'quote_financier_name',
'quote_product_solver_id',
'retail_price',
'site_owner_email',
'site_owner_organization_name',
'solar_spend_net_tax_savings_incentives_total',
'solar_spend_net_tax_savings_incentives_yr[year]',
'solar_spend_total'
Metrics Updated:
'contract_address_line_1',
'contract_city_name',
'contract_county_name',
'contract_state_abbreviation',
'contract_zipcode',
'legal_contact_email_[order]',
'legal_contact_first_name_[order]',
'legal_contact_id_[order]',
'legal_contact_last_name_[order]',
'legal_contact_name_[order]'
'legal_site_address_line_1',
'legal_site_city_name',
'legal_site_county_name',
'legal_site_state_abbreviation',
'legal_site_zipcode'
All of these are now more accurately determined using QualificationProcess preference order
Sprint 2.14 - 12/7/17 Release (expected)
incentives_[incentive_type]_[assignee]_yr[year] - incentive type given to an assignee in a specified year (expected)
- example: incentives_itc_s_yr1, the first year itc assigned to the siteowner
- incentive_type options: pbi, stc, ongoing, rbt, itc, rec, upfront; all types are option
- assignees: i, f, s (installer, financier, siteowner)
- year is required
incentives_[incentive_type]_[assignee]_cum_yr[year] - incentive type given to an assigned over the specified number of years, starting from year 1 (expected)
- example: incentives_ongoing_f_cumyr20, the cumulate ongoing incentives assigned to the financier over the next 20 years
- incentive_type options: pbi, stc, ongoing, rbt, itc, rec, upfront; all types are option
- assignees: i, f, s (installer, financier, siteowner)
- year is required
- federal_tax_savings_cum_yr[year] - cumulative federal tax deductions over the specified number of years, starting from year 1 (expected)
- federal_tax_savings_yr[year] - single year federal tax savings (expected)
- state_tax_savings_cum_yr[year] - cumulative state tax deductions over the specified number of years, starting from year 1 (expected)
- state_tax_savings_yr[year] - single year state tax savings (expected)
- total_tax_savings_cum_yr[year] - cumulative tax deductions over the specified number of years, starting from year 1 (expected)
- total_tax_savings_yr[year] - single year total tax savings (expected)
- savings_cum_yr[year] - cumulative savings over the specified number of years, starting from year 1 (expected)
- savings_yr[year] - single year savings (expected)
- savings_yr[year] = utility bill pre - utility bill post - solar bill + year 1 Incentives, excluding upfront
Sprint 2.13 - 11/16/17 Release
New:
- array_id_x
- array_inverter_count_x (replaces: array_n_inverters_x)
- array_module_count_x (replaces: array_number_of_modules_x)
- array_inverter_manufacturer_x
- array_inverter_model_x
- array_module_manufacturer_x
- array_module_model_x
- array_capacity_x
- system_module_models
- system_inverter_models
- system_inverter_model_counts
- system_module_model_counts
- system_inverter_manufacturer_counts
- system_module_manufacturer_counts
- system_inverter_manufacturers
- system_module_manufacturers
- system_snapshot_url - returns a URL that has the image of the designed system
Sprint 2.12 - 11/02/17 Release
New:
- signed_baseline_date - date field to track when a new contract or addendum is signed, and the data is stored at the contract level
Sprint 2.11 - 10/19/17 Release
New:
- solar_spend_average_monthly_yr[year] - average cost of solar for a specified year (expected)
- utility_bill_pre_average_monthly_yr[year] - average utility bill for a specified year if there is no solar system installed (expected)
- utility_bill_post_average_monthly_yr[year] - average utility bill for a specified year after the designed solar system is installed (expected)
- site_usage_yr[year] - annual energy usage for a specified year (expected)
- federal_tax_rate
- state_tax_rate
Sprint 2.10 - 10/5/17 Release
New:
- contract_contact_name_[index] - the full name of each signer
Sprint 2.9 - 9/25/17 Release
New:
workflow_id - returns a list of unique identifiers for the all workflows associated with a quote
system_id - returns the system UUID for a quote or system, or a list of systems IDs for a site
- system_number_of_modules - returns the number of modules for a given system
Name Changes:
monthly_payment - used to be quote_monthly_payment
contract _apr - used to be quote_contract_apr
monthly_payment_no_prepay - used to be quote_monthly_payment_no_prepay
initial_contract_signed_date - used to be initial_contract_date
organization_id - used to be organization_uuid
module_rating_nominal_X - used to be stc_dc_rating_array_X
array_number_of_modules_X - used to be module_count_array_X
inverter_efficiency_X - used to be inverter_efficiency_array_X
inverter_uses_optimizers_X - used to be inverter_uses_optimizers_array_X
Logic Changes:
install_cost - returns the install cost in dollars (not $/w)
Removed:
contact_email_list - request contact_email and a list will be returned as applicable
contact_names - request contact_name and a list will be returned as applicable
contact_phone_number_list - request contact_phone_number and a list will be returned as applicable
owned_by_organization - duplicate of organization_name
product_names - request product_name and a list will be returned as applicable
quote_owned_by_user - internal ID - not useful for external integrators
site_owned_by_user - internal ID - not useful for external integrators
General Enhancements:
introduced indexing for improved reporting and data access
introduced the workflow-data endpoint
improved baseline mapping to ensure metrics had the same units
Sprint 2.8 - 9/7/2018 Release
New:
avg_utility_cost_pre - average cost of power pre-solar
credit_expiration_date - credit expiration date
ability to filter with credit_expiration_date_before / credit_expiration_after
array_solar_access_percent_X - solar access values for month x
initial_contract_date - date of the first signed contract in a workflow