Widget

GET 38 endpoints

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.

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

Gets the actual vs budget widget.

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

Retrieves a count of bills for the specific widget

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

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.

/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 the carbon footprint data for a specific widget

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

Retrieves data for commodity cost dashboard widget

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

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

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

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

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

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

/api/v3/widget/singleenergystarbuilding/{specificWidgetId} 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

/api/V202502/widget/esademandintervaldata/{specificWidgetId} GetEsaDemandIntervalDataWidgetV202502

Returns data for the ESA demand interval data widget

/api/V202509/widget/esaheatmap/{specificWidgetId} GetEsaHeatmapWidgetV202509

Returns data for the ESA heatmap widget

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

Returns data for the esa interval data widget

/api/v202501/widget/trendinsights/{specificWidgetId} GetEsaSentinelWidgetV202501

Retrieve Trend Insights (previously "ESA Sentinel") readings and predictions for a Channel.

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

Retrieves energy use intensity data for a specific widget.

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

Get building rank by GHG emissions or intensity.

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

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

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

Get ranking by GHG emissions.

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

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

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

Gets the bar rank and tree map widgets.

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

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

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

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

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

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.

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

Gets data for the Monthly Cost Trend widget.

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

Retrieves monthly cost trend for a dashboard widget

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

Returns data for the monthly trend widget

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

Gets data for the Monthly Use Trend widget.

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

Retrieves monthly global use trend for a dashboard widget

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

Retrieves the most expensive building data for a specific widget

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

Retrieves the most expensive meters data for a specific widget

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

Retrieves data for the Rolling Monthly Comparison Widget.

/api/v3/widget GetWidgetsV3

Retrieves an array of widgets.

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

Returns data for the monthly savings trend widget

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

Returns data for the monthly savings trend widget