PlaceDigest
GET
20 endpoints
/api/v3/place/{placeId}/digest/energyUseIntensity
GetEuiChartDataV3
Retrieves energy use intensity data for a place.
If data is requested for an organization, then all the places under the organization will be rolled up.
/api/v3/place/digest/actual/monthly
GetPlaceActualMonthlyListV3
Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up.
/api/v3/place/{placeId}/digest/actual/monthly
GetPlaceActualMonthlyV3
Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up.
/api/v3/place/digest/actual/yearly
GetPlaceActualYearlyListV3
Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up.
/api/v3/place/{placeId}/digest/actual/yearly
GetPlaceActualYearlyV3
Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up.
/api/v202208/place/{placeId}/digest/calendarized/cost/comparison
GetPlaceCalendarizedCostComparisonV202208
Return the total cost and cost for each commodity under a place for comparison
Example calculating the current and previous ranges:
Today is 2022-10-06
chartMonthsToExclude = 2, numMonths = 6, comparisonYearsAgo = 3
CurrentPeriodRange is 202203 - 202208 and PreviousPeriodRange is 201903 - 201908
/api/v202208/place/{placeId}/digest/calendarized/ghg/comparison
GetPlaceCalendarizedGhgComparisonV202208
Return the total ghg and ghg for each commodity under a place for comparison
Example calculating the current and previous ranges:
Today is 2022-10-06
chartMonthsToExclude = 2, numMonths = 6, comparisonYearsAgo = 3
CurrentPeriodRange is 202203 - 202208 and PreviousPeriodRange is 201903 - 201908
/api/v3/place/digest/calendarized/monthly
GetPlaceCalendarizedMonthlyListV3
Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up.
/api/v3/place/{placeId}/digest/calendarized/monthly
GetPlaceCalendarizedMonthlyV3
Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up.
/api/v3/place/digest/calendarized/yearly
GetPlaceCalendarizedYearlyListV3
Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up.
/api/v3/place/{placeId}/digest/calendarized/yearly
GetPlaceCalendarizedYearlyV3
Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up.
/api/v3/place/digest/normalized/monthly
GetPlaceNomalizedMonthlyListV3
Retrieves rolled up normalized billing data by building/organization for a given number of years- Result includes use on a monthly basis. It also includes target comparison data and commodity level break up.
/api/v3/place/{placeId}/digest/normalized/monthly
GetPlaceNomalizedMonthlyV3
Retrieves rolled up normalized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up.
/api/v202208/place/{placeId}/digest/normalized/use/comparison
GetPlaceNormalizedUseComparisonV202208
Return the total use and use for each commodity under a place for comparison
Example calculating the current and previous ranges:
Today is 2022-10-06
chartMonthsToExclude = 2, numMonths = 6, comparisonYearsAgo = 3
CurrentPeriodRange is 202203 - 202208 and PreviousPeriodRange is 201903 - 201908
/api/v3/place/digest/normalized/yearly
GetPlaceNormalizedYearlyListV3
Retrieves rolled up normalized billing data by building/organization for a given number of years- Result include use on an yearly basis. It also includes target comparison data and commodity level break up.
/api/v3/place/{placeId}/digest/normalized/yearly
GetPlaceNormalizedYearlyV3
Retrieves rolled up normalized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up.
/api/v3/place/digest/savings/monthly
GetPlaceSavingsMonthlyListV3
Retrieves rolled up savings data by building/organization for a given number of years- Result includes cost and use savings on a monthly basis.
/api/v3/place/{placeId}/digest/savings/monthly
GetPlaceSavingsMonthlyV3
Retrieves rolled up savings data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up.
/api/v3/place/digest/savings/yearly
GetPlaceSavingsYearlyListV3
Retrieves rolled up savings billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes a commodity level break up.
/api/v3/place/{placeId}/digest/savings/yearly
GetPlaceSavingsYearlyV3