Sign in
telemetry

Get OpenTelemetry traces within a specified time window with flexible pagination options: Pass in only the end time to paginate backwards from there. Pass in a start time to paginate backwards from now until the start time. Pass in both to get resources within the time window. Choose to return in end_time order instead to view traces that completed in a window or since a time. Filter additionally by branch_ids or file_id.

get/v1/telemetry/traces

Query parameters

file_idstring uuid

Include only resources from a given file identified by its ID

branch_idsstring[]

Branch IDs to filter by

direction'asc' | 'desc' required

Sort direction for the traces. Defaults to descending order of timestamp.

startstring date-time

Start date of the time window (earliest time)

endstring date-time

End date of the time window (latest time)

limitinteger required

Maximum items to return in each paginated response

order_by'start_time' | 'end_time'

When set to end_time, traces are sorted by their end time, and pending traces are omitted. When set to start_time, all traces are included, with pending traces given "0" for their end time.

Response

A paginated result set

Changes

Changed in 6 of the 46 revisions of this API.4311

  • dc1b3c9e3b2a24See the full diff
    • ▲

      the query request parameter direction was restricted to a list of enum values

      request-parameter-became-enum

    • ▲

      the query request parameter order_by was restricted to a list of enum values

      request-parameter-became-enum

    • ○

      added the new enum value asc to the query request parameter direction

      request-parameter-enum-value-added

    • ○

      added the new enum value desc to the query request parameter direction

      request-parameter-enum-value-added

    • ○

      added the new enum value end_time to the query request parameter order_by

      request-parameter-enum-value-added

    • ○

      added the new enum value start_time to the query request parameter order_by

      request-parameter-enum-value-added

  • 6b03e553fa2e1See the full diff
    • ▲

      added the new required query request parameter direction

      new-required-request-parameter

  • 03e1768a53611See the full diff
    • ○

      the query request parameter order_by became optional

      request-parameter-became-optional

  • bad403b1755f1See the full diff
    • ▲

      added the new required query request parameter order_by

      new-required-request-parameter

  • a09036acdbe935See the full diff
    • ●

      deleted the query request parameter end_timestamp

      request-parameter-removed

    • ●

      deleted the query request parameter offset

      request-parameter-removed

    • ●

      deleted the query request parameter start_timestamp

      request-parameter-removed

    • ○

      api tag telemetry added

      api-tag-added

    • ○

      api tag traces removed

      api-tag-removed

    • ○

      added the new optional query request parameter end

      new-optional-request-parameter

    • ○

      added the new optional query request parameter start

      new-optional-request-parameter

    • ○

      removed the non-success response with the status 400

      response-non-success-status-removed

  • eba4827c2e6a1See the full diff
    • ○

      endpoint added

      endpoint-added