Retrieve a metric definition

Use this reference to retrieve a specific metric definition.

The default format will be JSON if none is specified.

The servlet will use the HTTP Accept header as a hint if no specific format is specified.

URL

/api/v1/metrics/{metricId}\{.format}

Method

GET

Formats

JSON, XML

Query parameters

Parameters N/A

Example

Metric with ID backend-sequential-writes in XML format.

curl \
  -X GET
  https://<metricsServerHost>:8080/api/v1/metrics/backend-sequential-
writes.xml

Response Code

200 0K

Response Body

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<countMetric xmlns="com.unboundid.directory.mon.api.v1"
id="backend-sequential-writes" name="Sequential Disk Writes"
shortName="Sequential Writes" group="Directory Server Backend">
<description>Number of Sequential I/O Disk writes
made by backend</description>
<instanceTypes>
  <instanceType>ds</instanceType>
</instanceTypes>
  <statistics>
<statistic>count</statistic>
  </statistics>
    <dimensions>
      <dimension id="backend">
        <values>
          <value>userroot</value>
        </values>
      </dimension>
    </dimensions>
  <countUnit singularName="Sequential Write"
pluralName="Sequential Writes" abbreviatedName="Seq Wr" />
</countMetric>

PingDirectory

Retrieve a metric definition

Example