# Create treemap

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

> Returns the proportional distribution of metrics by sample count or time-series count, as the entries of a treemap.

`POST /v1/o11y/metrics/treemap`

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

Returns the proportional distribution of metrics by sample
count or time-series count, as the entries of a treemap.

## Request

6 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 entries come back, between 1 and 5000.            |
| `mode`              | body | string                | yes      | Mode picks the measure: timeseries or samples.                        |
| `start`             | body | integer (int64)       | yes      | Start is the start of the window as a Unix timestamp in milliseconds. |

## Response

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

`200` body — 10 fields.

| Field                          | In   | Type                     | Always | Description                                                     |
| ------------------------------ | ---- | ------------------------ | ------ | --------------------------------------------------------------- |
| `data`                         | body | o11y.O11yMetricTreemap   | —      |                                                                 |
| `data.samples`                 | body | o11y.O11yTreemapEntry\[] | —      | Samples are the entries when measuring by sample count.         |
| `data.samples[].metricName`    | body | string                   | —      | MetricName is the metric's name.                                |
| `data.samples[].percentage`    | body | number (double)          | —      | Percentage is the metric's share, in percent.                   |
| `data.samples[].totalValue`    | body | integer (uint64)         | —      | TotalValue is the metric's absolute count.                      |
| `data.timeseries`              | body | o11y.O11yTreemapEntry\[] | —      | TimeSeries are the entries when measuring by time-series count. |
| `data.timeseries[].metricName` | body | string                   | —      | MetricName is the metric's name.                                |
| `data.timeseries[].percentage` | body | number (double)          | —      | Percentage is the metric's share, in percent.                   |
| `data.timeseries[].totalValue` | body | integer (uint64)         | —      | TotalValue is the metric's absolute count.                      |
| `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 treemap \
  --end 0 \
  --limit 0 \
  --mode <mode> \
  --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.getMetricsTreemap({ start: 0, end: 0, limit: 0, mode: "<mode>" });
```

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

**.go**

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

resp, _, err := client.O11yAPI.GetMetricsTreemap(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_treemap(&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).getMetricsTreemap();
```

**HTTP**

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

**MCP**

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

---

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