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

Retrieves energy use intensity (EUI) data for a place

GetEuiChartDataV3 Permissions: BuildingsAndOrganizations (View)
Use this endpoint to get EUI calculations for a specific place. For organizations, all child places are rolled up. Not available for accounts using 13-period or custom accounting cycles (validation will fail). EUI is calculated as total energy use divided by place size (area).

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Path Parameters

Name Description Type Required
placeId Unique numeric identifier of the place to retrieve EUI data for integer (int32) Required

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

Array of:

PlaceDigestEnergyUseIntensity
Property Description Type
calendarPeriod The calendar period number integer (int32)
calendarYear The calendar year integer (int32)
commodities A breakdown of use per commodity PlaceDigestEnergyUseIntensity+EuiCommodity[]
PlaceDigestEnergyUseIntensity+EuiCommodity properties
Property Description Type
commodityCode The commodity code string
commodityId The commodity identifier integer (int32)
commodityInfo The commodity info string
use The use for the commodity number (double)
usePercent The percent of the building’s energy used by the commodity number (double)
energyProjects A list of energy projects for this building. To be listed, a project must end in this period. Projects are only displayed at the building level, but not at the organization level PlaceDigestEnergyUseIntensity+EuiEnergyProject[]
PlaceDigestEnergyUseIntensity+EuiEnergyProject properties
Property Description Type
energyProjectCode The energy project code string
energyProjectId The energy project identifier integer (int32)
energyProjectInfo The energy project info string
installationCost The energy project installation cost number (double)
globalUseUnit UnitChild
UnitChild properties
Property Description Type
unitCode The unit code string
unitId The unit identifier integer (int32)
unitInfo The unit info string
periodName The calendar period name string
usePerAreaGoal The target use per area for this place for this year. Only populated when an EUI goal has been created for this place, and a milestone exists for this year number (double)
usePerAreaTrend The running average use per area for the prior 12 months number (double)
Example Response application/json 
[
  {    "calendarPeriod": 1,    "calendarYear": 1,    "commodities": [
      {      "commodityCode": "string",      "commodityId": 1,      "commodityInfo": "string",      "use": 1.0,      "usePercent": 1.0
    }
    ],    "energyProjects": [
      {      "energyProjectCode": "string",      "energyProjectId": 1,      "energyProjectInfo": "string",      "installationCost": 1.0
    }
    ],    "globalUseUnit": {      "unitCode": "string",      "unitId": 1,      "unitInfo": "string"
    },    "periodName": "string",    "usePerAreaGoal": 1.0,    "usePerAreaTrend": 1.0
  }
]
404 Not Found The requested resource was not found. Verify the ID or path is correct.