Widget APIs

Get /api/v3/widget

Operation: GetWidgetsV3

Retrieves an array of widgets.


Get /api/v3/widget/eui/{specificWidgetId}

Operation: GetEuiChartWidgetDataV3

Retrieves energy use intensity data for a specific widget.


Get /api/v3/widget/missingbills/{specificWidgetId}

Operation: GetMissingBillsV3 Paginated

Returns gaps in billing data for a date range specified by the Bill Date Range filter.
A gap is defined as at least one day that falls within the account’s service dates and
not included in any bill for that account meter.
The Allowable Gap Days filter specifies the number of days that must be in the gap
before it will be included in the results.


Get /api/v3/widget/billsoverduefromvendor/{specificWidgetId}

Operation: GetBillsOverdueFromVendorV3 Paginated

Retrieves data about bills that have not yet been received from vendors.
NOTE: Does not support global dashboard filtering with Topmost Place, Place Group API filters.


Get /api/v3/widget/intervaldata/{specificWidgetId}

Operation: GetIntervalDataV3

Retrieves interval data for a specific widget
NOTE: Does not support global dashboard filtering with Topmost Place, Place Group API filters.


Get Deprecated /api/v3/widget/map/{specificWidgetId}

Operation: GetMapPlacesV3

Retrieves map data for a specific map widget
NOTE: Does not support global dashboard filtering with Topmost Place, Place Group API filters.


Get /api/v3/widget/multipleenergystarbuildings/{specificWidgetId}

Operation: GetEnergyStarMultipleBuildingsV3 Paginated

Retrieves a list of buildings for the Multiple ENERGY STAR Buildings widget.
The widget is expecting zero, one, or many buildings, and alters its layout based on how many results it receives.

Validation:
- The provided specific widget must exist
- The provided specific widget must be an Multiple ENERGY STAR Buildings widget


Get /api/v3/widget/singleenergystarbuilding/{specificWidgetId}

Operation: GetEnergyStarSingleBuildingV3

Retrieves ENERGY STAR place score history for a building

Validation:
- The provided specific widget must exist
- The provided specific widget must be an ENERGY STAR Single Building widget


Get /api/v3/widget/actionablebillcounts/{specificWidgetId}

Operation: GetActionableBillCountsV3

Returns counts of bills Held from Export, bills Waiting for Export to AP, bills Waiting for Export to GL, bills which are Not Approved, bills with unresolved flags,
and bills created in the past seven days.


Get /api/v3/widget/mostexpensivebuildings/{specificWidgetId}

Operation: GetMostExpensiveBuildingsV3

Retrieves the most expensive building data for a specific widget


Get Deprecated /api/v3/widget/monthlyusetrend/{specificWidgetId}

Operation: GetMonthlyUseTrendV3

Retrieves monthly global use trend for a dashboard widget


Get Deprecated /api/v3/widget/monthlycosttrend/{specificWidgetId}

Operation: GetMonthlyCostTrendV3

Retrieves monthly cost trend for a dashboard widget


Get /api/v3/widget/carbonfootprint/{specificWidgetId}

Operation: GetCarbonFootprintV3

Retrieves the carbon footprint data for a specific widget


Get Deprecated /api/v3/widget/programsavings/{specificWidgetId}

Operation: GetCostAvoidanceProgramSavingsV3

Returns Cost Avoidance Savings Program-to-date. The user can set the topmost place and/or commodity filters.


Get Deprecated /api/v3/widget/monthlysavingstrend/{specificWidgetId}

Operation: MonthlyCAPTrendV3

Returns data for the monthly savings trend widget


Get /api/v3/widget/mostexpensivemeters/{specificWidgetId}

Operation: GetMostExpensiveMetersV3

Retrieves the most expensive meters data for a specific widget


Get /api/v3/widget/commoditycost/{specificWidgetId}

Operation: GetCommodityCostV3

Retrieves data for commodity cost dashboard widget


Get Deprecated /api/v3/widget/costavoidancebycommodity/{specificWidgetId}

Operation: CostAvoidanceByCommodityV3

Retrieves data for cost avoidance by commodity dashboard widget


Get Deprecated /api/v3/widget/billcount/{specificWidgetId}

Operation: GetBillCountV3

Retrieves a count of bills for the specific widget


Get /api/v3/widget/exec/{specificWidgetId}

Operation: ExecuteSprocWidgetV3


Get /api/v202501/widget/esasentinel/{specificWidgetId}

Operation: GetEsaSentinelWidgetV202501

Retrieves ESA Sentinel predictions for a specific widget


Get /api/v202411/widget/esaintervaldata/{specificWidgetId}

Operation: GetEsaIntervalDataWidgetV202411

Returns data for the esa interval data widget


Get /api/v202311/widget/actualvsbudget/{specificWidgetId}

Operation: GetActualVsBudgetV202311

Gets the actual vs budget widget.


Get /api/v202302/widget/monthlyusetrend/{specificWidgetId}

Operation: GetMonthlyUseTrendV202302

Gets data for the Monthly Use Trend widget.


Get /api/v202302/widget/monthlycosttrend/{specificWidgetId}

Operation: GetMonthlyCostTrendV202302

Gets data for the Monthly Cost Trend widget.


Get /api/v202302/widget/itemrank/{specificWidgetId}

Operation: GetItemRankV202302

Gets the bar rank and tree map widgets.


Get /api/v202302/widget/programsavings/{specificWidgetId}

Operation: GetCostAvoidanceProgramSavingsV202302

Returns Cost Avoidance Savings Program-to-date. The user can set the topmost place and/or commodity filters.


Get /api/v202302/widget/costavoidancebycommodity/{specificWidgetId}

Operation: CostAvoidanceByCommodityV202302

Retrieves data for cost avoidance by commodity dashboard widget


Get /api/v202302/widget/monthlysavingstrend/{specificWidgetId}

Operation: MonthlyCAPTrendV202302

Returns data for the monthly savings trend widget


Get /api/v202302/widget/monthlytrend/{specificWidgetId}

Operation: GetMonthlyTrendV202302

Returns data for the monthly trend widget


Get /api/v202301/widget/rollingmonthlycomparison/{specificWidgetId}

Operation: GetRollingComparisonV202301

Retrieves data for the Rolling Monthly Comparison Widget.


Get /api/v202212/widget/ghgbuildingrank/{specificWidgetId}

Operation: GetGHGBuildingRankV202212

Get building rank by GHG emissions or intensity.


Get /api/v202212/widget/ghgscopecategoryrank/{specificWidgetId}

Operation: GetGHGRankingV202212

Get ranking by GHG emissions.


Get /api/v202212/widget/ghgperformance/{specificWidgetId}

Operation: GetGHGPerformanceV202212

Gets the greenhouse gas performance by commodity, scope or scope category.


Get /api/v202211/widget/carbonfootprint/{specificWidgetId}

Operation: GetCarbonFootprintDataV202211

Retrieves yearly Carbon Emissions data that is split by year, then by Gas Type and one of the following group types:
( Scope, Scope Category, Commodity ). Also includes target data, if target comparisons are enabled and set.


Get /api/v202209/widget/map/{specificWidgetId}

Operation: GetMapWidgetV202209

Retrieves map data for a specific map widget
NOTE: Does not support global dashboard filtering with Topmost Place, Place Group API filters.