Hanzo
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}

Addresshttps://api.hanzo.ai/v1/o11y/reviews/{id}
MethodGET
Operationget_o11y_reviews_by_id
AuthAuthorization: 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.

FieldInTypeRequiredDescription
idpathstringyesID is the annotation queue to act on, from the path.

Response

StatusBodyMeaning
200o11y.annQueueDetailViewok

200 body — 21 fields.

FieldInTypeAlwaysDescription
completedCountbodyintegerCompletedCount is how many have been reviewed.
createdAtbodystringCreatedAt is when it was created, RFC3339 in UTC.
descriptionbodystringDescription is its free text, omitted when empty.
idbodystringID is the queue's id.
itemsbodyo11y.annItemView[]Items is the queue's first page of items (up to 100).
items[].assigneebodystringAssignee is the reviewer it is for, omitted when unassigned.
items[].completedAtbodystringCompletedAt is when it was reviewed, omitted while pending.
items[].createdAtbodystringCreatedAt is when it was enqueued, RFC3339 in UTC.
items[].idbodystringID is the item's id.
items[].objectIdbodystringObjectID is the referenced object's id.
items[].objectTypebodystringObjectType is what it references: TRACE, OBSERVATION or SESSION.
items[].observationIdbodystringObservationID echoes objectId when objectType is OBSERVATION.
items[].queueIdbodystringQueueID is the queue it belongs to.
items[].sessionIdbodystringSessionID echoes objectId when objectType is SESSION.
items[].statusbodystringStatus is PENDING or COMPLETED.
items[].traceIdbodystringTraceID echoes objectId when objectType is TRACE.
items[].updatedAtbodystringUpdatedAt is when it last changed, RFC3339 in UTC.
namebodystringName is its display handle.
pendingCountbodyintegerPendingCount is how many of its items are still awaiting review.
scoreConfigIdsbodystring[]ScoreConfigIDs are the eval score-configs reviewers grade against.
updatedAtbodystringUpdatedAt is when it last changed, RFC3339 in UTC.

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y reviews get <id>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page