> ## Documentation Index
> Fetch the complete documentation index at: https://docs.basaltic.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar rastreamentos

> Retorna um resumo por trace_id distinto, mais recente primeiro. Configuração de paginação de chave (start_time, trace_id). `from` e `to` são obrigatórios; a janela deve ser no máximo 31 dias. Requer `telemetry:ReadTraces`.


<Info>
  Requer a ação do IAM **`telemetry:ReadTraces`**. Consulte [permissões de telemetria](/telemetry/permissions) para obter a lista completa, o que cada uma abrange e um exemplo de política.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/telemetry.yaml get /v1/traces
openapi: 3.0.3
info:
  title: API de Telemetria Basaltica
  version: 1.0.0
  description: >
    API de telemetria regional — grupos de log + ingestão/pesquisa de log,
    métricas do ClickHouse (remote_write + consulta estruturada com envelopes
    JSON compatíveis com Prometheus), ingestão de intervalo e configurações de
    pesquisa/detalhes de rastreamento + rastreamento por conta.


    As referências de solicitação de grupo de log aceitam UUIDs, CRNs ou nomes
    exatos de escopo de conta, classificados por sintaxe sem fallback de
    pesquisa. Os CRNs devem corresponder ao identificador de conta autenticado e
    à região de atendimento. Os logs HTTP e gRPC OTLP usam basaltic.log_group,
    voltando para service.name, com o mesmo contrato de referência.
    Identificadores de rastreamento/espaço, rótulos de métrica e dimensões de
    pesquisa de região são valores de protocolo, independentes da resolução do
    recurso.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://telemetry.{region}.basaltic.sh
    description: Endpoint de API regional (um por região)
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
paths:
  /v1/traces:
    get:
      tags:
        - Telemetry
      summary: Listar rastreamentos
      description: >
        Retorna um resumo por trace_id distinto, mais recente primeiro.
        Configuração de paginação de chave (start_time, trace_id). `from` e `to`
        são obrigatórios; a janela deve ser no máximo 31 dias. Requer
        `telemetry:ReadTraces`.
      operationId: searchTraces
      parameters:
        - name: from
          in: query
          required: true
          description: Limite inferior no intervalo start_time (inclusive)
          schema:
            type: string
            format: date-time
            example: '2026-01-15T00:00:00Z'
        - name: to
          in: query
          required: true
          description: >-
            Limite superior no intervalo start_time (exclusivo); deve ser após e
            dentro de 31d
          schema:
            type: string
            format: date-time
            example: '2026-01-16T00:00:00Z'
        - name: service
          in: query
          description: Filtrar por service.name
          schema:
            type: string
            example: api-gateway
        - name: operation
          in: query
          description: Filtrar por nome de intervalo (operação)
          schema:
            type: string
            example: GET /api/users
        - name: status_code
          in: query
          description: Filtrar por código de status
          schema:
            type: string
            enum:
              - UNSET
              - OK
              - ERROR
            example: ERROR
        - name: min_duration_ms
          in: query
          description: >-
            Filtrar para rastreamentos cuja duração de ponta a ponta é pelo
            menos este número de ms
          schema:
            type: number
            format: double
            minimum: 0
            example: 100
        - $ref: '#/components/parameters/LimitDefault50'
        - $ref: '#/components/parameters/Marker'
      responses:
        '200':
          description: Página de resumos de rastreamento
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TraceListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    LimitDefault50:
      name: limit
      in: query
      description: >-
        Número máximo de itens a devolver. Um valor acima do máximo é fixado ao
        invés de rejeitado, então uma página mais curta do que a que você pediu
        é normal — page until `meta.has_more` é false, não até que uma página
        pareça curta.
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
      example: 50
    Marker:
      name: marker
      in: query
      description: >-
        Cursor de paginação opaco. Echo back o valor `meta.marker` da página
        anterior para buscar a próxima; não construa ou analise-o. A forma
        interna do token varia de acordo com o endpoint (um ID de recurso, um
        carimbo de data/hora, etc.) e não é garantida a estabilidade entre
        versões.
      required: false
      schema:
        type: string
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    TraceListResponse:
      type: object
      properties:
        traces:
          type: array
          items:
            $ref: '#/components/schemas/TraceSummary'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    TraceSummary:
      type: object
      properties:
        trace_id:
          type: string
          example: 4bf92f3577b34da6a3ce929d0e0e4736
        root_span_id:
          type: string
          example: 00f067aa0ba902b7
        root_name:
          type: string
          example: GET /api/users
        root_service:
          type: string
          example: api-gateway
        start_time:
          type: string
          format: date-time
          example: '2026-01-15T09:30:00Z'
        duration_ms:
          type: number
          format: double
          example: 12.4
        span_count:
          type: integer
          example: 18
        error_count:
          type: integer
          example: 0
        service_count:
          type: integer
          example: 4
    PaginationMeta:
      type: object
      properties:
        total:
          type: integer
          description: Número total de itens
          example: 150
        limit:
          type: integer
          description: Número de itens por página
          example: 20
        marker:
          type: string
          description: >-
            Cursor opaco para a próxima página. Passe-o de volta como o
            parâmetro de consulta `marker`; trate-o como um token, não um valor
            para analisar.
          example: 550e8400-e29b-41d4-a716-446655440000
        has_more:
          type: boolean
          description: Se há mais itens
          example: true
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de erro identificando o tipo de erro
              example: INVALID_INPUT
            message:
              type: string
              description: Mensagem de erro legível pelo ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores não sensíveis opcionais para interpolação de erros
                localizados, codificados por código de erro. Nunca presente para
                erros de servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuração
              example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    BadRequest:
      description: Parâmetros de solicitação inválidos
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_INPUT
              message: Invalid request parameters
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Unauthorized:
      description: Autenticação necessária ou token inválido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Permissões insuficientes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InternalServerError:
      description: Erro interno do servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An internal error occurred
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Um token bearer OAuth 2.0, enviado como `Authorization: Bearer <token>`.
        Esta é a forma recomendada de autenticação.


        Obtenha o token trocando o par de chaves de acesso de uma conta de
        serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
        Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
        com OAuth podem obter e renovar o token para você.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
        também serve como credencial AWS SigV4 para o endpoint de objetos
        compatível com S3, que aceita somente esse método de autenticação.


````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.