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

Get Custom Metrics

Updated on February 26, 2024

Description

This web service returns a list of custom metrics for a specific property. A maximum of 3 custom metrics per property can be defined. The property must already be shared with you.

Version

23.0

HTTP Method

GET

Resource URL

/property/(propertyId)/customMetrics

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id to the property

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Request

The example below retrieves the list of custom metrics that are defined for a property that has an id of 14.

GET  /property/14/customMetrics

Example Response

The example below shows the list of custom metrics that are defined for a property that has an id of 14.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links>
          <link id="1" hint="Custom Metric #1 - Site Energy Use per Gross Floor Area" linkDescription="This is the GET url for this Custom Metric." link="/property/14/customMetrics/1" httpMethod="GET"/>
          <link id="2" hint="Custom Metric #2 - Site Energy Use per Gross Floor Area" linkDescription="This is the GET url for this Custom Metric." link="/property/14/customMetrics/2" httpMethod="GET"/>
          <link id="3" hint="Custom Metric #3 - Site Energy Use per Computer" linkDescription="This is the GET url for this Custom Metric." link="/property/14/customMetrics/3" httpMethod="GET"/>
     </links>
</response>
LIVE