Widget
GET
38 endpoints
/api/v202302/widget/costavoidancebycommodity/{specificWidgetId}
CostAvoidanceByCommodityV202302
Retrieves cost avoidance by commodity data for a widget
/api/v3/widget/costavoidancebycommodity/{specificWidgetId}
Deprecated
CostAvoidanceByCommodityV3
Retrieves cost avoidance by commodity data for a Cost Avoidance by Commodity widget.
/api/v3/widget/exec/{specificWidgetId}
ExecuteSprocWidgetV3
Executes a stored-procedure-based widget and returns type-specific data.
/api/v3/widget/actionablebillcounts/{specificWidgetId}
GetActionableBillCountsV3
Retrieves actionable bill status counts for a Bill Status widget.
/api/v202311/widget/actualvsbudget/{specificWidgetId}
GetActualVsBudgetV202311
Retrieves actual vs budget comparison data for a widget
/api/v3/widget/billcount/{specificWidgetId}
Deprecated
GetBillCountV3
Retrieves a bill count for a specific bill count widget.
/api/v3/widget/billsoverduefromvendor/{specificWidgetId}
GetBillsOverdueFromVendorV3
Retrieves data about bills that have not yet been received from vendors.
/api/v202211/widget/carbonfootprint/{specificWidgetId}
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.
/api/v3/widget/carbonfootprint/{specificWidgetId}
GetCarbonFootprintV3
Retrieves carbon footprint (GHG emissions) data for a Carbon Footprint widget.
/api/v3/widget/commoditycost/{specificWidgetId}
GetCommodityCostV3
Retrieves commodity cost data for a Commodity Cost widget.
/api/v202302/widget/programsavings/{specificWidgetId}
GetCostAvoidanceProgramSavingsV202302
Retrieves cost avoidance program savings data for a widget
/api/v3/widget/programsavings/{specificWidgetId}
Deprecated
GetCostAvoidanceProgramSavingsV3
Retrieves cost avoidance program savings data for a Program Savings widget.
/api/v3/widget/multipleenergystarbuildings/{specificWidgetId}
GetEnergyStarMultipleBuildingsV3
Retrieves ENERGY STAR data for multiple buildings in the Multiple ENERGY STAR Buildings widget.
/api/v3/widget/singleenergystarbuilding/{specificWidgetId}
GetEnergyStarSingleBuildingV3
Retrieves ENERGY STAR data for a single building in the Single ENERGY STAR Building widget.
/api/V202502/widget/esademandintervaldata/{specificWidgetId}
GetEsaDemandIntervalDataWidgetV202502
Retrieves ESA demand interval data for a widget
/api/V202509/widget/esaheatmap/{specificWidgetId}
GetEsaHeatmapWidgetV202509
Retrieves ESA heatmap data for a widget
/api/v202411/widget/esaintervaldata/{specificWidgetId}
GetEsaIntervalDataWidgetV202411
Retrieves ESA interval data for a widget
/api/v202501/widget/trendinsights/{specificWidgetId}
GetEsaSentinelWidgetV202501
Retrieves Trend Insights (Sentinel) readings and predictions for a channel widget
/api/v3/widget/eui/{specificWidgetId}
GetEuiChartWidgetDataV3
Retrieves energy use intensity (EUI) data for a specific EUI chart widget.
/api/v202212/widget/ghgbuildingrank/{specificWidgetId}
GetGHGBuildingRankV202212
Retrieves building rank by GHG emissions or intensity
/api/v202212/widget/ghgperformance/{specificWidgetId}
GetGHGPerformanceV202212
Retrieves GHG performance comparison by commodity, scope, or scope category
/api/v202212/widget/ghgscopecategoryrank/{specificWidgetId}
GetGHGRankingV202212
Retrieves GHG scope category ranking by emissions
/api/v3/widget/intervaldata/{specificWidgetId}
GetIntervalDataV3
Retrieves interval data (readings) for a specific interval data widget.
/api/v202302/widget/itemrank/{specificWidgetId}
GetItemRankV202302
Retrieves bar rank and tree map widget data
/api/v3/widget/map/{specificWidgetId}
Deprecated
GetMapPlacesV3
Retrieves map place data for a specific map widget.
/api/v202209/widget/map/{specificWidgetId}
GetMapWidgetV202209
Retrieves map data for a specific map widget
/api/v3/widget/missingbills/{specificWidgetId}
GetMissingBillsV3
Retrieves gaps in billing data for a date range specified by the widget's Bill Date Range filter.
/api/v202302/widget/monthlycosttrend/{specificWidgetId}
GetMonthlyCostTrendV202302
Retrieves monthly cost trend data for a widget
/api/v3/widget/monthlycosttrend/{specificWidgetId}
Deprecated
GetMonthlyCostTrendV3
Retrieves monthly cost trend data for a Monthly Cost Trend widget.
/api/v202302/widget/monthlytrend/{specificWidgetId}
GetMonthlyTrendV202302
Retrieves monthly trend data for a widget
/api/v202302/widget/monthlyusetrend/{specificWidgetId}
GetMonthlyUseTrendV202302
Retrieves monthly use trend data for a widget
/api/v3/widget/monthlyusetrend/{specificWidgetId}
Deprecated
GetMonthlyUseTrendV3
Retrieves monthly use trend data for a Monthly Use Trend widget.
/api/v3/widget/mostexpensivebuildings/{specificWidgetId}
GetMostExpensiveBuildingsV3
Retrieves the most expensive buildings data for a Most Expensive Buildings widget.
/api/v3/widget/mostexpensivemeters/{specificWidgetId}
GetMostExpensiveMetersV3
Retrieves the most expensive meters data for a Most Expensive Meters widget.
/api/v202301/widget/rollingmonthlycomparison/{specificWidgetId}
GetRollingComparisonV202301
Retrieves data for the Rolling Monthly Comparison widget
/api/v3/widget
GetWidgetsV3
Retrieves all available widget types that can be added to a dashboard.
/api/v202302/widget/monthlysavingstrend/{specificWidgetId}
MonthlyCAPTrendV202302
Retrieves monthly savings trend data for a widget
/api/v3/widget/monthlysavingstrend/{specificWidgetId}
Deprecated
MonthlyCAPTrendV3
Retrieves monthly cost avoidance trend data for a Monthly CAP Trend widget.