Web Service Documentation / Categories / Reporting Services / Get Available Metrics List
Updated on February 26, 2024
23.0
GET
/reports/metrics?groupIds=(groupIds)&availableToCustomMetrics=(availableToCustomMetrics)
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials |
Yes
Parameter Name | Description |
---|---|
availableToCustomMetrics | Optional. If set to true then a list of metrics is returned that can be used to define in a custom metric (in the numerator). If set to false then a list of metrics is returned that cannot be used to define in a custom metric (in the numerator). If omitted then all metrics are returned. |
groupIds | Optional. Comma delimited list of group unique identifiers to filter on. Defaults to all groups. |
Request/Response | Schema Name |
---|---|
Request | None |
Response | reportMetrics.xsd |
The example below retrieves the list of metrics that are in groups with a groupId of 1 and 13.
GET /reports/metrics?groupIds=1,13
The example below retrieves the list of all the metrics.
GET /reports/metrics
The following example shows the results when you call this web service. The availableToCustomMetrics attribute indicates whether the metric can be used to define a custom metric.
<?xml version="1.0" encoding="UTF-8"?>
<reportMetrics>
<group id="1" name="Data Accuracy">
<metrics>
<metric id="6" name="estimatedDataFlagElectricityGridPurchase" description="Estimated Data Flag - Electricity (Grid Purchase)" dataType="string" availableToCustomMetrics="false"/>
<metric id="7" name="estimatedDataFlagElectricityOnsiteSolar" description="Estimated Data Flag - Electricity (Onsite Solar)" dataType="string" availableToCustomMetrics="false"/>
<metric id="9" name="estimatedDataFlagNaturalGas" description="Estimated Data Flag - Natural Gas" dataType="string" availableToCustomMetrics="false"/>
<metric id="10" name="estimatedDataFlagFuelOilNo2" description="Estimated Data Flag - Fuel Oil (No. 2)" dataType="string" availableToCustomMetrics="false"/>
<!-- assume more records -->
</metrics>
</group>
<group id="2" name="Data Center Metrics">
<metrics>
<metric id="132" name="dataCenterSourcePUE" description="Data Center - PUE" dataType="numeric"/>
<metric id="133" name="dataCenterITEquipmentInputSiteEnergy" description="Data Center - IT Equipment Input Meter" dataType="numeric" uom="kWh" availableToCustomMetrics="true"/>
<metric id="134" name="dataCenterPDUInputSiteEnergy" description="Data Center - PDU Input Meter" dataType="numeric" uom="kWh" availableToCustomMetrics="true"/>
<metric id="135" name="dataCenterPDUOutputSiteEnergy" description="Data Center - PDU Output Meter" dataType="numeric" uom="kWh" availableToCustomMetrics="true"/>
<metric id="136" name="dataCenterUPSOutputSiteEnergy" description="Data Center - UPS Output Meter" dataType="numeric" uom="kWh" availableToCustomMetrics="true"/>
<metric id="137" name="dataCenterITSiteEnergy" description="Data Center - IT Site Energy" dataType="numeric" uom="kWh" availableToCustomMetrics="true"/>
<metric id="138" name="dataCenterITSourceEnergy" description="Data Center - IT Source Energy" dataType="numeric" uom="kBtu" availableToCustomMetrics="true"/>
<metric id="139" name="dataCenterPUEMedian" description="Data Center - National Median PUE" dataType="numeric" availableToCustomMetrics="true"/>
</metrics>
</group>
<group id="3" name="Property Design">
<metrics>
<metric id="140" name="designScore" description="Design ENERGY STAR Score" dataType="numeric" availableToCustomMetrics="true"/>
<metric id="141" name="designSiteTotal" description="Design Site Energy Use" dataType="numeric" uom="kBtu" availableToCustomMetrics="true"/>
<!-- assume more records -->
</metrics>
</group>
<!-- assume more records -->
</reportMetrics>