Traces

Get Trace

Changed on

Get a single trace with its hierarchical span tree.

Args: trace_id: The ID of the trace to retrieve. current_user: The authenticated user (required for authorization).

Returns: TraceRead containing the trace and its hierarchical span tree.

get/api/v1/monitor/traces/{trace_id}

Request

  • The document declares no server URL.
  • Auth
    • OAuth 2
      Password
      Token URL: api/v1/login
    • or API key in query parameter x-api-key
    • or API key in header x-api-key

Path parameters

trace_idstring uuid required

Response

Successful Response

endTimestring date-time nullable required
flowIdstring uuid required
idstring uuid required
namestring required
sessionIdstring required
startTimestring date-time nullable required
status'unset' | 'ok' | 'error' required

OpenTelemetry status codes.

  • UNSET: Default status, span has not ended yet
  • OK: Span completed successfully
  • ERROR: Span completed with an error
totalLatencyMsinteger required
totalTokensinteger required

Changes

  • a5c4fa6a88f7Revision changes
    • breaking

      response property input list-of-types was widened by adding types string to media type application/json of response 200

    • breaking

      response property output list-of-types was widened by adding types string to media type application/json of response 200

  • 830c31118215Revision changes
    • info

      endpoint added