---
title: Retrieve a metric definition
description: Use this reference to retrieve a specific metric definition.
component: pingdirectory
version: 9.3
page_id: pingdirectory:pingdatametrics_server_administration_guide:pd_met_retrieve_metric_def
canonical_url: https://docs.pingidentity.com/pingdirectory/9.3/pingdatametrics_server_administration_guide/pd_met_retrieve_metric_def.html
revdate: September 13, 2023
section_ids:
  example: Example
---

# 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.

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

|               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Response Code | 200 0K                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Response Body | ```xml
<?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>
``` |