Create treemap

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

POST /v1/o11y/metrics/treemap

Addresshttps://api.hanzo.ai/v1/o11y/metrics/treemap
MethodPOST
OperationGetMetricsTreemap
AuthAuthorization: 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).

FieldInTypeRequiredDescription
endbodyinteger (int64)yesEnd is the end of the window as a Unix timestamp in milliseconds.
filterbodyo11y.O11yMetricFilter—
filter.expressionbodystring—Expression is the filter, in the query-builder filter syntax.
limitbodyinteger (int64)yesLimit caps how many entries come back, between 1 and 5000.
modebodystringyesMode picks the measure: timeseries or samples.
startbodyinteger (int64)yesStart is the start of the window as a Unix timestamp in milliseconds.

Response

StatusBodyMeaning
200o11y.O11yMetricTreemapOutok
202Approvalheld for approval
defaultproblem-detailsrefused

200 body — 10 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yMetricTreemap—
data.samplesbodyo11y.O11yTreemapEntry[]—Samples are the entries when measuring by sample count.
data.samples[].metricNamebodystring—MetricName is the metric's name.
data.samples[].percentagebodynumber (double)—Percentage is the metric's share, in percent.
data.samples[].totalValuebodyinteger (uint64)—TotalValue is the metric's absolute count.
data.timeseriesbodyo11y.O11yTreemapEntry[]—TimeSeries are the entries when measuring by time-series count.
data.timeseries[].metricNamebodystring—MetricName is the metric's name.
data.timeseries[].percentagebodynumber (double)—Percentage is the metric's share, in percent.
data.timeseries[].totalValuebodyinteger (uint64)—TotalValue is the metric's absolute count.
statusbodystring—Status is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y metrics treemap \
  --end 0 \
  --limit 0 \
  --mode <mode> \
  --start 0
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>" });
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>")
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
}
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?;
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();
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>"
     }'

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

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 · All Hanzo APIs · Interactive reference

Was this page useful?