announcement

There has been a lapse in Environmental Protection Agency appropriations. EPA intends to keep the ENERGY STAR website, tools, and resources available, however they will not be updated regularly. If you submit a question, application, or request to EPA, it may not be processed during this period.

Web Service Documentation / Categories / Reporting Services / Get Report Results

Get Report Results

Updated on February 26, 2024

Description

This web service retrieves the results of a report. Depending on the size of the results, it either returns a file stream based on the file type you specify (Excel or XML) or a zip file. The report must be owned by you.

For more information on whether a zip file is returned, please see the Compressed and batched large Data Request download files bullet here.

Version

25.0

HTTP Method

GET

Resource URL

/reports/(reportId)/download?type=(type)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
reportId Id of the report
type The type of file to return as a stream. Valid values are:
  • EXCEL    (same as in the user interface)
  • XML
Note that depending on the size of the results, a zip file can be returned.

XML Schemas

Request/Response Schema Name
Request None
Response None

Example Request

The following example downloads the results for a report.

GET  /reports/23554/download?type=EXCEL

Example Response

An EXCEL file is streamed back.

<?xml version="1.0" encoding="UTF-8"?>
<null>
     <!-- Not applicable -->
</null>
TEST