header.banner.text
Web Service Documentation / Categories / Reporting Services
Reporting Services
The Reporting Services allows you to retrieve metrics for your properties. These services are divided into 2 categories. The first category involves a set of APIs that allow you to interface with the Custom Reporting feature within the Portfolio Manager user interface. For more information, please see the Custom Reporting API Guide. These APIs also allow you to interface with over 10 ENERGY STAR reports that EPA has predefined. For more information, please see the ENERGY STAR Reports API Guide. All metric calculations initiated by these APIs behave asynchronously. The second category involves the original set of APIs that allow you to retrieve a smaller set of metric calculations which behave synchronously.
Custom Reporting (Template Management)
| Method | REST URI * | Description |
|---|---|---|
| GET | /reports/metrics?groupIds=(groupIds)&availableToCustomMetrics=(availableToCustomMetrics) | Returns a list of available metrics to use in a report template. |
| POST | /reports/templates | Creates a report template in your account. Returns unique identifiers for both the template and the corresponding report. |
| GET | /reports/templates/(templateId) | Returns the information for a specific report template. The report template must be owned by you. |
| PUT | /reports/templates/(templateId) | Updates the information for a specific report template. The report template must be owned by you. |
| DELETE | /reports/templates/(templateId) | Deletes a specified report template. The report template must be owned by you. |
| GET | /reports/templates?type=(type) | Returns a list of report templates in your account. |
Custom Reporting (Report Management)
| Method | REST URI * | Description |
|---|---|---|
| GET | /reports/(reportId) | Returns the information for a specific report. The report must be owned by you. |
| PUT | /reports/(reportId) | Updates the information for a specific report. The report must be owned by you. |
| GET | /reports/(reportId)/download?type=(type) | Downloads the results for a specific report. The report must be owned by you. |
| POST | /reports/(reportId)/generate | Generates a specific report. The report must be owned by you. |
| GET | /reports/(reportId)/status | Returns the status information for a specific report. The report must be owned by you. |
| GET | /reports?type=(type) | Returns a list of reports in your account. |
Reporting
| Method | REST URI * | Description |
|---|---|---|
| GET | /property/(propertyId)/design/metrics | Returns a list of metric values for an existing property design. The property must already be shared with you. |
| GET | /property/(propertyId)/metrics | Returns the values for a specified set of metrics and units for a specific property and period ending date. The property must already be shared with you. |
| GET | /property/(propertyId)/metrics/monthly | Returns a list of monthly metric values for a specific property and period ending date based on the specified set of metrics and measurement system. |
| GET | /property/(propertyId)/reasonsForNoScore | Returns a list of alert information that explains why a specific property cannot receive an ENERGY STAR score for a specific period ending date. |
| GET | /property/(propertyId)/reasonsForNoWaterScore | Returns a list of alert information that explains why a specific property cannot receive an ENERGY STAR water score for a specific period ending date. |
| GET | /property/(propertyId)/useDetails/metrics | Returns the time-weighted use detail values for a specific property, period ending date, and measurement system. The property must already be shared with you. |
* For the TEST environment, relative to the base URI: https://portfoliomanager.energystar.gov/wstest
** Web services are only available in the TEST environment.
