PlaceDigest APIs

Get /api/v3/place/digest/actual/yearly

Operation: GetPlaceActualYearlyListV3 Permissions: BuildingsAndOrganizations (View) Paginated

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.

Get /api/v3/place/{placeId}/digest/actual/yearly

Operation: GetPlaceActualYearlyV3 Permissions: BuildingsAndOrganizations (View)

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.

Get /api/v3/place/digest/calendarized/yearly

Operation: GetPlaceCalendarizedYearlyListV3 Permissions: BuildingsAndOrganizations (View) Paginated

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.

Get /api/v3/place/{placeId}/digest/calendarized/yearly

Operation: GetPlaceCalendarizedYearlyV3 Permissions: BuildingsAndOrganizations (View)

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.

Get /api/v3/place/digest/normalized/yearly

Operation: GetPlaceNormalizedYearlyListV3 Permissions: BuildingsAndOrganizations (View) Paginated

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.

Get /api/v3/place/{placeId}/digest/normalized/yearly

Operation: GetPlaceNormalizedYearlyV3 Permissions: BuildingsAndOrganizations (View)

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.

Get /api/v3/place/digest/savings/yearly

Operation: GetPlaceSavingsYearlyListV3 Permissions: BuildingsAndOrganizations (View) Paginated

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.

Get /api/v3/place/{placeId}/digest/savings/yearly

Operation: GetPlaceSavingsYearlyV3 Permissions: BuildingsAndOrganizations (View)

Get /api/v3/place/digest/actual/monthly

Operation: GetPlaceActualMonthlyListV3 Permissions: BuildingsAndOrganizations (View) Paginated

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.

Get /api/v3/place/{placeId}/digest/actual/monthly

Operation: GetPlaceActualMonthlyV3 Permissions: BuildingsAndOrganizations (View)

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.

Get /api/v3/place/digest/calendarized/monthly

Operation: GetPlaceCalendarizedMonthlyListV3 Permissions: BuildingsAndOrganizations (View) Paginated

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.

Get /api/v3/place/{placeId}/digest/calendarized/monthly

Operation: GetPlaceCalendarizedMonthlyV3 Permissions: BuildingsAndOrganizations (View)

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.

Get /api/v3/place/digest/normalized/monthly

Operation: GetPlaceNomalizedMonthlyListV3 Permissions: BuildingsAndOrganizations (View) Paginated

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.

Get /api/v3/place/{placeId}/digest/normalized/monthly

Operation: GetPlaceNomalizedMonthlyV3 Permissions: BuildingsAndOrganizations (View)

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.

Get /api/v3/place/digest/savings/monthly

Operation: GetPlaceSavingsMonthlyListV3 Permissions: BuildingsAndOrganizations (View) Paginated

Retrieves rolled up savings data by building/organization for a given number of years- Result includes cost and use savings on a monthly basis.

Get /api/v3/place/{placeId}/digest/savings/monthly

Operation: GetPlaceSavingsMonthlyV3 Permissions: BuildingsAndOrganizations (View)

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.

Get /api/v3/place/{placeId}/digest/energyUseIntensity

Operation: GetEuiChartDataV3 Permissions: BuildingsAndOrganizations (View)

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.

Get /api/v202208/place/{placeId}/digest/normalized/use/comparison

Operation: GetPlaceNormalizedUseComparisonV202208 Permissions: BuildingsAndOrganizations (View)

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

Get /api/v202208/place/{placeId}/digest/calendarized/cost/comparison

Operation: GetPlaceCalendarizedCostComparisonV202208 Permissions: BuildingsAndOrganizations (View)

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

Get /api/v202208/place/{placeId}/digest/calendarized/ghg/comparison

Operation: GetPlaceCalendarizedGhgComparisonV202208 Permissions: BuildingsAndOrganizations (View)

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