# List metrics — GET /v1/o11y/metrics

URL: https://docs.hanzo.ai/docs/openapi/o11y/listmetrics

> Lists the distinct metric names seen in a time range, each with its description, type, unit, temporality and monotonicity.

`GET /v1/o11y/metrics`

> [O11y →](https://docs.hanzo.ai/docs/openapi/o11y) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                        |
| ------------- | -------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/o11y/metrics` |
| **Method**    | `GET`                                  |
| **Operation** | `ListMetrics`                          |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY` |

Lists the distinct metric names seen in a time range, each with
its description, type, unit, temporality and monotonicity.

## Request

5 fields.

| Field        | In    | Type    | Required | Description                                                           |
| ------------ | ----- | ------- | -------- | --------------------------------------------------------------------- |
| `start`      | query | integer | —        | Start is the start of the window as a Unix timestamp in milliseconds. |
| `end`        | query | integer | —        | End is the end of the window as a Unix timestamp in milliseconds.     |
| `limit`      | query | integer | —        | Limit caps how many metrics come back; unset means 100, at most 5000. |
| `searchText` | query | string  | —        | SearchText narrows the page to metric names containing it.            |
| `source`     | query | string  | —        | Source narrows the page by ingestion source.                          |

## Response

| Status    | Body                   | Meaning           |
| --------- | ---------------------- | ----------------- |
| `200`     | o11y.O11yMetricListOut | ok                |
| `202`     | Approval               | held for approval |
| `default` | problem-details        | refused           |

`200` body — 9 fields.

| Field                        | In   | Type                      | Always | Description                                          |
| ---------------------------- | ---- | ------------------------- | ------ | ---------------------------------------------------- |
| `data`                       | body | o11y.O11yMetricList       | —      |                                                      |
| `data.metrics`               | body | o11y.O11yMetricSummary\[] | —      | Metrics are the metrics, with their metadata.        |
| `data.metrics[].description` | body | string                    | —      | Description describes the metric.                    |
| `data.metrics[].isMonotonic` | body | boolean                   | —      | IsMonotonic marks a sum that only ever increases.    |
| `data.metrics[].metricName`  | body | string                    | —      | MetricName is the metric's name.                     |
| `data.metrics[].temporality` | body | string                    | —      | Temporality is delta or cumulative.                  |
| `data.metrics[].type`        | body | string                    | —      | Type is the metric type, e.g. gauge, sum, histogram. |
| `data.metrics[].unit`        | body | string                    | —      | Unit is the metric's unit.                           |
| `status`                     | body | string                    | —      | Status is "success".                                 |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo o11y metrics get
```

**SDK**

**.ts**

```ts
import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.listMetrics();
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import O11yApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = O11yApi(client).list_metrics()
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.O11yAPI.ListMetrics(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, o11y_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = o11y_api::list_metrics(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new O11yApi(client).listMetrics();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/o11y/metrics \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

Tool `o11y`, op `ListMetrics` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`.

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "o11y",
         "arguments": {
           "op": "ListMetrics",
           "input": {}
         }
       }
     }'
```

---

[O11y API](https://docs.hanzo.ai/docs/openapi/o11y) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)