# Create stats — POST /v1/o11y/metrics/stats

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

> Lists metrics with their sample and time-series counts for a time range — the volume view of the metrics explorer, pageable and sortable.

`POST /v1/o11y/metrics/stats`

> [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/stats` |
| **Method**    | `POST`                                       |
| **Operation** | `GetMetricsStats`                            |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`       |

Lists metrics with their sample and time-series counts for a
time range — the volume view of the metrics explorer, pageable and sortable.

## Request

15 fields, body `application/json` (required).

| Field                       | In   | Type                  | Required | Description                                                               |
| --------------------------- | ---- | --------------------- | -------- | ------------------------------------------------------------------------- |
| `end`                       | body | integer (int64)       | yes      | End is the end of the window as a Unix timestamp in milliseconds.         |
| `filter`                    | body | o11y.O11yMetricFilter | —        |                                                                           |
| `filter.expression`         | body | string                | —        | Expression is the filter, in the query-builder filter syntax.             |
| `limit`                     | body | integer (int64)       | yes      | Limit caps how many metrics come back, between 1 and 5000.                |
| `offset`                    | body | integer (int64)       | —        | Offset is how many metrics to skip, for paging.                           |
| `orderBy`                   | body | o11y.O11yMetricOrder  | —        |                                                                           |
| `orderBy.direction`         | body | string                | —        | Direction is asc or desc.                                                 |
| `orderBy.key`               | body | o11y.O11yMetricField  | —        |                                                                           |
| `orderBy.key.description`   | body | string                | —        | Description describes the field.                                          |
| `orderBy.key.fieldContext`  | body | string                | —        | FieldContext is the context the field lives in, e.g. resource, attribute. |
| `orderBy.key.fieldDataType` | body | string                | —        | FieldDataType is the field's data type.                                   |
| `orderBy.key.name`          | body | string                | —        | Name is the field's name.                                                 |
| `orderBy.key.signal`        | body | string                | —        | Signal is the telemetry signal the field belongs to.                      |
| `orderBy.key.unit`          | body | string                | —        | Unit is the field's unit.                                                 |
| `start`                     | body | integer (int64)       | yes      | Start is the start of the window as a Unix timestamp in milliseconds.     |

## Response

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

`200` body — 10 fields.

| Field                        | In   | Type                   | Always | Description                                          |
| ---------------------------- | ---- | ---------------------- | ------ | ---------------------------------------------------- |
| `data`                       | body | o11y.O11yMetricStats   | —      |                                                      |
| `data.metrics`               | body | o11y.O11yMetricStat\[] | —      | Metrics are the counted metrics.                     |
| `data.metrics[].description` | body | string                 | —      | Description describes the metric.                    |
| `data.metrics[].metricName`  | body | string                 | —      | MetricName is the metric's name.                     |
| `data.metrics[].samples`     | body | integer (uint64)       | —      | Samples is how many samples the metric had.          |
| `data.metrics[].timeseries`  | body | integer (uint64)       | —      | TimeSeries is how many time series the metric had.   |
| `data.metrics[].type`        | body | string                 | —      | Type is the metric type.                             |
| `data.metrics[].unit`        | body | string                 | —      | Unit is the metric's unit.                           |
| `data.total`                 | body | integer (uint64)       | —      | Total is how many metrics matched, across all pages. |
| `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 stats \
  --end 0 \
  --limit 0 \
  --start 0
```

**SDK**

**.ts**

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

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMetricsStats({ start: 0, end: 0, limit: 0 });
```

**.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).get_metrics_stats(start=0, end=0, limit=0)
```

**.go**

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

resp, _, err := client.O11yAPI.GetMetricsStats(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::get_metrics_stats(&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).getMetricsStats();
```

**HTTP**

```bash
curl -X POST https://api.hanzo.ai/v1/o11y/metrics/stats \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "start": 0,
       "end": 0,
       "limit": 0
     }'
```

**MCP**

Tool `o11y`, op `GetMetricsStats` — 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": "GetMetricsStats",
           "input": {
             "start": 0,
             "end": 0,
             "limit": 0
           }
         }
       }
     }'
```

---

[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)
