Hanzo
OpenapiO11y

Returns a page of one review queue's items, newest first, optionally filtered…

Returns a page of one review queue's items, newest first, optionally filtered to PENDING or COMPLETED.

GET /v1/o11y/reviews/{id}/items

Addresshttps://api.hanzo.ai/v1/o11y/reviews/{id}/items
MethodGET
Operationget_o11y_reviews_by_id_items
AuthAuthorization: Bearer $HANZO_API_KEY

Returns a page of one review queue's items, newest first, optionally filtered to PENDING or COMPLETED. A queue id belonging to another org is a 404, never a cross-tenant list.

Request

4 fields.

FieldInTypeRequiredDescription
idpathstringyesID is the annotation queue whose items to list, from the path.
statusquerystringStatus filters to PENDING or COMPLETED items.
pagequeryintegerPage is the 1-based page to read.
limitqueryintegerLimit is how many rows to return.

Response

StatusBodyMeaning
200o11y.annItemListok

200 body — 18 fields.

FieldInTypeAlwaysDescription
databodyo11y.annItemView[]Data is the page of items.
data[].assigneebodystringAssignee is the reviewer it is for, omitted when unassigned.
data[].completedAtbodystringCompletedAt is when it was reviewed, omitted while pending.
data[].createdAtbodystringCreatedAt is when it was enqueued, RFC3339 in UTC.
data[].idbodystringID is the item's id.
data[].objectIdbodystringObjectID is the referenced object's id.
data[].objectTypebodystringObjectType is what it references: TRACE, OBSERVATION or SESSION.
data[].observationIdbodystringObservationID echoes objectId when objectType is OBSERVATION.
data[].queueIdbodystringQueueID is the queue it belongs to.
data[].sessionIdbodystringSessionID echoes objectId when objectType is SESSION.
data[].statusbodystringStatus is PENDING or COMPLETED.
data[].traceIdbodystringTraceID echoes objectId when objectType is TRACE.
data[].updatedAtbodystringUpdatedAt is when it last changed, RFC3339 in UTC.
metabodyo11y.listMeta
meta.limitbodyintegerLimit is how many rows one page holds.
meta.pagebodyintegerPage is the 1-based page this response is.
meta.totalItemsbodyintegerTotalItems is how many rows match in total.
meta.totalPagesbodyintegerTotalPages is ceil(totalItems/limit), at least 1.

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y reviews items list <id>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page