telemetry

Changed on

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

Request

  • Base URL
    https://api.val.town
  • URL
    https://api.val.town/v1/telemetry/traces
  • Auth
    none declared

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

  • dc1b3c9e3b2aRevision changes
    • breaking

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

    • breaking

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

    • info

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

    • info

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

    • info

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

    • info

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

  • 6b03e553fa2eRevision changes
    • breaking

      added the new required query request parameter direction