Traces

Get Traces

Changed on

Get list of traces for a flow.

Args: current_user: Authenticated user (required for authorization) flow_id: Filter by flow ID session_id: Filter by session ID status: Filter by trace status query: Search query for trace name/id/session id start_time: Filter traces starting on/after this time (ISO) end_time: Filter traces starting on/before this time (ISO) page: Page number (1-based) size: Page size

Returns: List of traces

get/api/v1/monitor/traces

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

Query parameters

flow_idstring uuid nullable
session_idstring nullable
status'unset' | 'ok' | 'error'

OpenTelemetry status codes.

  • UNSET: Default status, span has not ended yet
  • OK: Span completed successfully
  • ERROR: Span completed with an error
querystring nullable
start_timestring date-time nullable
end_timestring date-time nullable
pageinteger
sizeinteger

Response

Successful Response

pagesinteger required
totalinteger required

Changes

  • a5c4fa6a88f7Revision changes
    • breaking

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

    • breaking

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

  • 830c31118215Revision changes
    • info

      endpoint added