> ## 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.

# Pesquisar registros de log

> Retorna logs para a organização atual, mais recente primeiro, com paginação de conjunto de chaves ativada (timestamp, id). A pesquisa de corpo de texto livre é uma substring que não faz distinção entre maiúsculas e minúsculas; filtros por atributo usam a convenção de parâmetro de consulta `attr.<key>=<value>`. `from` e `to` são obrigatórios; a janela deve ser no máximo 31 dias. Requer `telemetry:ReadLogs` permissão.


<Info>
  Requer a ação do IAM **`telemetry:ReadLogs`**. 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/logs
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/logs:
    get:
      tags:
        - Telemetry
      summary: Pesquisar registros de log
      description: >
        Retorna logs para a organização atual, mais recente primeiro, com
        paginação de conjunto de chaves ativada (timestamp, id). A pesquisa de
        corpo de texto livre é uma substring que não faz distinção entre
        maiúsculas e minúsculas; filtros por atributo usam a convenção de
        parâmetro de consulta `attr.<key>=<value>`. `from` e `to` são
        obrigatórios; a janela deve ser no máximo 31 dias. Requer
        `telemetry:ReadLogs` permissão.
      operationId: searchLogs
      parameters:
        - name: from
          in: query
          required: true
          description: Limite inferior no carimbo de data/hora (inclusive)
          schema:
            type: string
            format: date-time
            example: '2026-01-15T00:00:00Z'
        - name: to
          in: query
          required: true
          description: >-
            Limite superior no carimbo de data/hora (exclusivo); deve ser após e
            dentro de 31d
          schema:
            type: string
            format: date-time
            example: '2026-01-16T00:00:00Z'
        - name: log_group
          in: query
          description: >-
            Filtrar por UUID de grupo de log, CRN ou nome exato na conta
            autenticada. Os CRNs devem corresponder à região de atendimento e ao
            identificador da conta; referências inválidas nunca retornam a
            nomes.
          schema:
            type: string
            example: /app/prod/api
        - name: log_stream
          in: query
          description: Filtrar por nome de fluxo dentro do grupo
          schema:
            type: string
            example: api-host-07
        - name: min_severity
          in: query
          description: Filtrar para registros com severidade >= esta faixa
          schema:
            type: string
            enum:
              - TRACE
              - DEBUG
              - INFO
              - WARN
              - ERROR
              - FATAL
            example: WARN
        - name: region
          in: query
          description: Filtrar por região de emissor
          schema:
            type: string
            example: sa-saopaulo-1
        - name: q
          in: query
          description: Substring não sensível a maiúsculas no corpo do log
          schema:
            type: string
            example: status=200
        - name: trace_id
          in: query
          description: Filtrar para registros que levam este id de rastreamento W3C
          schema:
            type: string
            example: 4bf92f3577b34da6a3ce929d0e0e4736
        - $ref: '#/components/parameters/LimitDefault50'
        - $ref: '#/components/parameters/Marker'
      responses:
        '200':
          description: Página de registros de log
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogListResponse'
        '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:
    LogListResponse:
      type: object
      properties:
        logs:
          type: array
          items:
            $ref: '#/components/schemas/LogRecord'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    LogRecord:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        timestamp:
          type: string
          format: date-time
          description: Tempo de evento carimbado pelo produtor
          example: '2026-01-15T09:30:00Z'
        organization_id:
          type: string
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        account_id:
          type: string
          description: Conta de proprietário, vazia para eventos com escopo de organização
          example: 9b2e4d11-6c3a-4f8e-bd47-1a2b3c4d5e6f
        log_group_id:
          type: string
          format: uuid
          example: 1d3f5a72-8b90-4c1e-a2d6-7e8f9a0b1c2d
        log_group:
          type: string
          description: Nome do grupo de log pai
          example: /app/prod/api
        log_stream:
          type: string
          description: Nome do fluxo dentro do grupo (normalmente o host do produtor)
          example: api-host-07
        severity:
          type: string
          enum:
            - TRACE
            - DEBUG
            - INFO
            - WARN
            - ERROR
            - FATAL
          example: INFO
        severity_number:
          type: integer
          description: Faixa de severidade numérica OTel (1..24)
          example: 9
        body:
          type: string
          example: request completed status=200 dur=12ms
        attributes:
          type: object
          additionalProperties:
            type: string
        resource:
          type: object
          additionalProperties:
            type: string
        trace_id:
          type: string
          example: 4bf92f3577b34da6a3ce929d0e0e4736
        span_id:
          type: string
          example: 00f067aa0ba902b7
    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.