Hanzo
OpenapiO11y

Enqueues traces, observations or sessions on a review queue.

Enqueues traces, observations or sessions on a review queue.

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

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

Enqueues traces, observations or sessions on a review queue. Each item names exactly one object, either by traceId / observationId / sessionId or by objectType plus objectId; every item enters PENDING. A queue id belonging to another org is a 404.

Request

9 fields, body application/json (required).

FieldInTypeRequiredDescription
idpathstringyesID is the annotation queue to add to, from the path.
idbodystringID is the annotation queue to add to, from the path.
itemsbodyo11y.itemInput[]Items are the objects to enqueue for review, 1–200 per request.
items[].assigneebodystringAssignee is the reviewer this item is for, up to 512 characters.
items[].objectIdbodystringObjectID is the referenced object's id, paired with objectType.
items[].objectTypebodystringObjectType is TRACE, OBSERVATION or SESSION — the generic form, paired with objectId.
items[].observationIdbodystringObservationID references an observation — the console-friendly form of objectType=OBSERVATION.
items[].sessionIdbodystringSessionID references a session — the console-friendly form of objectType=SESSION.
items[].traceIdbodystringTraceID references a trace — the console-friendly form of objectType=TRACE.

Response

StatusBodyMeaning
201o11y.annItemsCreatedcreated

201 body — 13 fields.

FieldInTypeAlwaysDescription
databodyo11y.annItemView[]Data is every item created by this request, in request order.
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.

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y reviews items create <id>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page