Web Service Documentation / Categories / Reporting Services / Get Property Metrics

Get Property Metrics

Updated on August 6, 2014

Description

This web service returns a list of metric values for a specific property and period ending date based on the specified set of metrics and measurement system. The property must already be shared with you. A full list of the reporting metrics that are available through this service and related web services can be found here. The list includes the metric name, the appropriate web service call for the metric, and a glossary link. It can be sorted and filtered for ease of finding the metrics that you need.

Note: Metrics that are readily available through other web services, such as GET /property and GET /propertyUse are not included in the reporting web services, since they are already accessible elsewhere.

Version

23.0

HTTP Method

GET

Resource URL

/property/(propertyId)/metrics?year=(year)&month=(month)&measurementSystem=(measurementSystem)

Header

Field Name Value Comments
Authorization Basic credentials
PM-Metrics comma delimited list of metric identifiers A maximum of 10 metrics can be requested per call.

Authorization Required

Yes

Parameters

Parameter Name Description
measurementSystem Indicates the set of units for the metrics to be calculated from. Valid values are METRIC or EPA. There is no default value. If any of the following metrics were requested together or by itself, then measurementSystem is not required: score, directGHGEmissions, inDirectGHGEmissions, totalGHGEmissions
month Month of the period ending date for the metrics to be calculated from. Valid values are 1-12 where 1 is January and 12 is December.
propertyId Id of the property
year Year of the period ending date for the metrics to be calculated from.

XML Schemas

Request/Response Schema Name
Request None
Response propertyMetrics.xsd

Example Request

The following example retrieves the score and site energy (specified in the HTTP Header) for the property that has an id of 712 for the period ending date of 12/31/2000. The metrics were calculated using the METRIC measurement system.

PM-Metrics: score, siteTotal, sourceTotal,  siteIntensity, directGHGEmissions

GET  /property/712/metrics?year=2000&month=12&measurementSystem=EPA

Example Response

The following example shows the results for the metrics. Please note that the direct GHG emissions metric cannot be calculated for this property. Also, a "uom" attribute is provided for each metric indicating the unit of measure (if applicable).

<?xml version="1.0" encoding="UTF-8"?>
<propertyMetrics propertyId="712" month="12" year="2000" measurementSystem="EPA">
    <metric name="score" dataType="numeric">
        <value>75</value>
    </metric>
    <metric name="siteTotal" uom="kBtu" dataType="numeric">
        <value>197895.97966</value>
    </metric>
    <metric name="sourceTotal" uom="kBtu" dataType="numeric">
        <value>629036.25052</value>
    </metric>
    <metric name="siteIntensity" uom="kBtu/ft�" dataType="numeric">
        <value>7.915839</value>
    </metric>
    <metric name="directGHGEmissions" dataType="numeric">
        <value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
    </metric>
</propertyMetrics>
TEST