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

Get Report List

Updated on February 12, 2023

Description

This web service returns a list of reports in your account.

Version

23.0

HTTP Method

GET

Resource URL

/reports?type=(type)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
type Optional. Indicates the type of report templates to return. Valid values are:
  • CUSTOM
  • ENERGY_STAR
  • DATA_REQUEST
  • DATA_RESPONSE
Defaults to all. Currently CUSTOM and ENERGY_STAR are only supported at this time.

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Request

The following example retrieves all the custom reports.

GET  /reports?type=CUSTOM

Example Response

The following example shows the results when you call this web service.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links>
          <link id="2209517" hint="My Energy Savings" linkDescription="This is the GET url for this Report." link="/reports/2209517" httpMethod="GET"/>
          <link id="2209514" hint="Energy Report 2022" linkDescription="This is the GET url for this Report." link="/reports/2209514" httpMethod="GET"/>
          <link id="2209516" hint="Water Report 2022" linkDescription="This is the GET url for this Report." link="/reports/2209516" httpMethod="GET"/>
     </links>
</response>
LIVE