Create queue overview

Lists the messaging destinations observed in the window — one row per queue/destination/service combination with its throughput and latency columns.

POST /v1/o11y/messaging-queues/queue-overview

O11y → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/o11y/messaging-queues/queue-overview`
Method	`POST`
Operation	`post_o11y_messaging-queues_queue-overview`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Lists the messaging destinations observed in the window — one row per queue/destination/service combination with its throughput and latency columns. Filters narrow by queue system, destination, service or any span attribute.

Request

14 fields, body application/json (required).

Field	In	Type	Required	Description
`end`	body	integer (int64)	—	End is the window's end, epoch nanoseconds.
`filters`	body	o11y.O11yQueueFilterSet	—
`filters.items`	body	o11y.O11yQueueFilterRule[]	—	Items are the predicates.
`filters.items[].key`	body	o11y.O11yQueueFilterKey	—
`filters.items[].key.dataType`	body	string	—	DataType is the attribute's type: string, int64, float64 or bool.
`filters.items[].key.isColumn`	body	boolean	—	IsColumn marks an attribute materialized as its own store column.
`filters.items[].key.isJSON`	body	boolean	—	IsJSON marks an attribute read out of the span's JSON body.
`filters.items[].key.key`	body	string	—	Key is the attribute name.
`filters.items[].key.type`	body	string	—	Type says which plane the attribute lives on: tag or resource.
`filters.items[].op`	body	string	—	Op is the comparison, e.g. =, !=, in, contains.
`filters.items[].value`	body	any	—	Value is the operand; its JSON type follows the attribute's dataType.
`filters.op`	body	string	—	Op combines the items: AND or OR.
`limit`	body	integer (int64)	—	Limit caps how many rows come back.
`start`	body	integer (int64)	—	Start is the window's start, epoch nanoseconds.

Response

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

200 body — 5 fields.

Field	In	Type	Always	Description
`data`	body	o11y.O11yQueueRow[]	—	Data holds one row per messaging destination.
`data[].data`	body	object	—	Data holds the row's cells keyed by column name; each cell's JSON type is the column's own, so the bytes pass through verbatim.
`data[].data.*`	body	any	—
`data[].timestamp`	body	string (date-time)	—	Timestamp anchors the row in time.
`status`	body	string	—	Status is "success".

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo o11y messaging-queues queue-overview

.ts

.py

.go

.rs

.java

import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postO11yMessaging-queuesQueue-overview({ end: 0, filters: {"items":[{"key":{"dataType":null,"isColumn":null,"isJSON":null,"key":null},"op":"<op>","value":"<value>"}],"op":"<op>"} });

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).post_o11y_messaging-queues_queue-overview(end=0, filters={"items":[{"key":{"dataType":null,"isColumn":null,"isJSON":null,"key":null},"op":"<op>","value":"<value>"}],"op":"<op>"})

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

resp, _, err := client.O11yAPI.PostO11yMessaging-queuesQueue-overview(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::post_o11y_messaging-queues_queue-overview(&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).postO11yMessaging-queuesQueue-overview();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl -X POST https://api.hanzo.ai/v1/o11y/messaging-queues/queue-overview \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "end": 0,
       "filters": {
         "items": [
           {
             "key": {
               "dataType": null,
               "isColumn": null,
               "isJSON": null,
               "key": null
             },
             "op": "<op>",
             "value": "<value>"
           }
         ],
         "op": "<op>"
       }
     }'

MCP reaches o11y through the o11y tool, which names its 307 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_o11y_autocomplete_aggregate_attributes"
         }
       }
     }'

O11y API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousCreate producer NextList namespaces