{ "opencollection": "1.0.0", "info": { "name": "Arize-Phoenix REST annotation_configs traces API", "version": "1.0" }, "items": [ { "info": { "name": "traces", "type": "folder" }, "items": [ { "info": { "name": "List traces for a project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/projects/:project_identifier/traces", "params": [ { "name": "project_identifier", "value": "", "type": "path", "description": "The project identifier: either project ID or project name." }, { "name": "start_time", "value": "", "type": "query", "description": "Inclusive lower bound on trace start time (ISO 8601)" }, { "name": "end_time", "value": "", "type": "query", "description": "Exclusive upper bound on trace start time (ISO 8601)" }, { "name": "sort", "value": "", "type": "query", "description": "Sort field" }, { "name": "order", "value": "", "type": "query", "description": "Sort direction" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of traces to return" }, { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor (Trace GlobalID)" }, { "name": "include_spans", "value": "", "type": "query", "description": "If true, include full span details for each trace. This significantly increases response size and query latency, especially with large page sizes. Prefer fetching spans lazily for individual traces when possible." }, { "name": "session_identifier", "value": "", "type": "query", "description": "List of session identifiers to filter traces by. Each value can be either a session_id string or a session GlobalID. Only traces belonging to the specified sessions will be returned." } ] }, "docs": "List traces for a project" }, { "info": { "name": "Create trace annotations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/trace_annotations", "params": [ { "name": "sync", "value": "", "type": "query", "description": "If true, fulfill request synchronously." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create trace annotations" }, { "info": { "name": "Create a trace note", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/trace_notes", "body": { "type": "json", "data": "{}" } }, "docs": "Add a note annotation to a trace. By default each call appends a new note with an auto-generated UUIDv4 identifier, so multiple notes accumulate on the same trace. Callers may supply a non-empty `identifier` to upsert on (trace_id, name='note', identifier) — repeated calls with the same identifier overwrite the existing note, matching the semantics of structured annotations." }, { "info": { "name": "Delete a trace by identifier", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/traces/:trace_identifier", "params": [ { "name": "trace_identifier", "value": "", "type": "path", "description": "The trace identifier: either a relay GlobalID or OpenTelemetry trace_id" } ] }, "docs": "Delete an entire trace by its identifier. The identifier can be either:\n1. A Relay node ID (base64-encoded)\n2. An OpenTelemetry trace_id (hex string)\n\nThis will permanently remove all spans in the trace and their associated data." } ] } ], "bundled": true }