Web Service Documentation / Categories / Reporting Services / ENERGY STAR Reports API Guide

ENERGY STAR Reports API Guide

How the APIs are organized

The ENERGY STAR Reports APIs are organized around only one important component that you should be familiar with:

• Report

ENERGY STAR reports contain metrics that were selected by EPA to help you understand key aspects of your performance which means that there isn't a template component to interface with. Instead you will only be interfacing with a report component.

Report

A report component consists of a timeframe (i.e., specific period ending date, date range, etc.) and a set of properties. The unique identifier to this component will be referred to as the reportId. You interface with a report when you perform any of the following actions on an ENERGY STAR report:

• update the reporting timeframe
• update the set of properties
• generate the report
• check the report's status
• download the report results

Quick Reference Guide

Below is a quick reference guide to configure and run an ENERGY STAR report.

Setting the List of Properties and Timeframe of an ENERGY STAR Report

Step	Method	REST URI	Description
1.	GET	/reports?type=ENERGY_STAR	Get a current list of ENERGY STAR reports and the reportId to the corresponding report that you want to configure. This step can be skipped if you already know the particular ENERGY STAR report.
2.	PUT	/reports/(reportId)	Update the report with a list of properties and timeframe using the reportId.
3.	POST	/reports/(reportId)/generate	Generate the report using the reportId.
4.	GET	/reports/(reportId)/status	Check the report's status using the reportId until the report is finished generating.
5.	GET	/reports/(reportId)/download?type=(type)	Download the report results (if the report is finished generating) using the reportId. The report is streamed as a file. An Excel or XML file is streamed back and is not part of the XML response body.