OpenapiO11y
Returns one review queue with its pending and completed counts and its first…
Returns one review queue with its pending and completed counts and its first page of items.
GET /v1/o11y/reviews/{id}
| Address | https://api.hanzo.ai/v1/o11y/reviews/{id} |
| Method | GET |
| Operation | get_o11y_reviews_by_id |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns one review queue with its pending and completed counts and its first page of items. A queue id belonging to another org is a 404, never a cross-tenant read.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the annotation queue to act on, from the path. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | o11y.annQueueDetailView | ok |
200 body — 21 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
completedCount | body | integer | — | CompletedCount is how many have been reviewed. |
createdAt | body | string | — | CreatedAt is when it was created, RFC3339 in UTC. |
description | body | string | — | Description is its free text, omitted when empty. |
id | body | string | — | ID is the queue's id. |
items | body | o11y.annItemView[] | — | Items is the queue's first page of items (up to 100). |
items[].assignee | body | string | — | Assignee is the reviewer it is for, omitted when unassigned. |
items[].completedAt | body | string | — | CompletedAt is when it was reviewed, omitted while pending. |
items[].createdAt | body | string | — | CreatedAt is when it was enqueued, RFC3339 in UTC. |
items[].id | body | string | — | ID is the item's id. |
items[].objectId | body | string | — | ObjectID is the referenced object's id. |
items[].objectType | body | string | — | ObjectType is what it references: TRACE, OBSERVATION or SESSION. |
items[].observationId | body | string | — | ObservationID echoes objectId when objectType is OBSERVATION. |
items[].queueId | body | string | — | QueueID is the queue it belongs to. |
items[].sessionId | body | string | — | SessionID echoes objectId when objectType is SESSION. |
items[].status | body | string | — | Status is PENDING or COMPLETED. |
items[].traceId | body | string | — | TraceID echoes objectId when objectType is TRACE. |
items[].updatedAt | body | string | — | UpdatedAt is when it last changed, RFC3339 in UTC. |
name | body | string | — | Name is its display handle. |
pendingCount | body | integer | — | PendingCount is how many of its items are still awaiting review. |
scoreConfigIds | body | string[] | — | ScoreConfigIDs are the eval score-configs reviewers grade against. |
updatedAt | body | string | — | UpdatedAt is when it last changed, RFC3339 in UTC. |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y reviews get <id>import { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getO11yReviewsById({ id: 'id' });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_o11y_reviews_by_id(id='id')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.GetO11yReviewsById(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::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_o11y_reviews_by_id(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new O11yApi(client).getO11yReviewsById();curl https://api.hanzo.ai/v1/o11y/reviews/<id> \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches o11y through the o11y tool, which names its 340 operations with its own verbs — this one among them, under a name only the door 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": "get_o11y_alert_last"
}
}
}'How is this guide?