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

# Logs de rede

> Obter os logs de borda por requisição dos domínios da aplicação.

Retorna logs de borda por requisição (HTTP, país, status, bytes) para o domínio principal da aplicação e qualquer domínio personalizado configurado. A janela máxima de retenção é de 7 dias; o `start` é limitado à data de criação da aplicação.

<Info>
  Disponível apenas nos planos **Pro** e **Enterprise**. Rate limit de cache miss: 10 requisições por 60 segundos por proprietário.
</Info>

<ParamField header="Authorization" type="string" placeholder="Chave da API" required>
  A chave da API para sua conta. Você pode encontrá-la nas [configurações da conta](https://squarecloud.app/pt-br/account/security).
</ParamField>

### Parâmetros

<ParamField path="app_id" type="string" placeholder="ID da Aplicação" required>
  O ID da aplicação. Você pode encontrá-lo na URL do painel da sua aplicação.
</ParamField>

<ParamField query="start" type="string" placeholder="Timestamp ISO 8601" required>
  Timestamp inicial em formato ISO 8601. Não pode ser anterior à data de criação da aplicação ou mais antigo que 7 dias.
</ParamField>

<ParamField query="end" type="string" placeholder="Timestamp ISO 8601" required>
  Timestamp final em formato ISO 8601. Deve ser posterior ao `start`.
</ParamField>

### Resposta

<ResponseField name="status" type="string">
  Indica se a chamada foi bem-sucedida. `success` se bem-sucedida, `error` se não.
</ResponseField>

<ResponseField name="response" type="array">
  O conteúdo da resposta.

  <Expandable title="Alternar objeto">
    <ResponseField name="timestamp" type="string">
      Timestamp da requisição em formato ISO.
    </ResponseField>

    <ResponseField name="client" type="object">
      Informações sobre o cliente que fez a requisição.

      <Expandable title="Alternar objeto client">
        <ResponseField name="ip" type="string | null">O endereço IP do cliente.</ResponseField>
        <ResponseField name="country" type="string | null">O código do país do cliente.</ResponseField>
        <ResponseField name="location" type="string | null">A localização aproximada do cliente.</ResponseField>
        <ResponseField name="asn" type="string">O ASN do cliente.</ResponseField>
        <ResponseField name="agent" type="string | null">O user agent do cliente.</ResponseField>
        <ResponseField name="category" type="string | null">A categoria do cliente (ex. bot, humano).</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="request" type="object">
      Informações sobre a requisição recebida.

      <Expandable title="Alternar objeto request">
        <ResponseField name="mitigated" type="boolean">Indica se a requisição foi mitigada pelas proteções de borda.</ResponseField>
        <ResponseField name="method" type="string">Método HTTP utilizado.</ResponseField>
        <ResponseField name="host" type="string">Valor do header Host.</ResponseField>
        <ResponseField name="path" type="string">Caminho da requisição.</ResponseField>
        <ResponseField name="query" type="string | null">String de query.</ResponseField>
        <ResponseField name="protocol" type="string">Protocolo utilizado (ex. HTTP/2).</ResponseField>
        <ResponseField name="referer" type="string | null">Valor do header Referer.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="response" type="object">
      Informações sobre a resposta servida na borda.

      <Expandable title="Alternar objeto response">
        <ResponseField name="status" type="integer">Código de status HTTP retornado.</ResponseField>
        <ResponseField name="contentType" type="string | null">Content-Type da resposta.</ResponseField>
        <ResponseField name="cache" type="string | null">Status do cache (ex. HIT, MISS).</ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
    "status": "success",
    "response": [
      {
        "timestamp": "2025-12-01T12:00:00.000Z",
        "client": {
          "ip": "203.0.113.45",
          "country": "BR",
          "location": "São Paulo",
          "asn": "12345 - Example ISP",
          "agent": "Mozilla/5.0",
          "category": null
        },
        "request": {
          "mitigated": false,
          "method": "GET",
          "host": "my-app.squareweb.app",
          "path": "/api/users",
          "query": "?limit=10",
          "protocol": "HTTP/2",
          "referer": null
        },
        "response": {
          "status": 200,
          "contentType": "application/json",
          "cache": "MISS"
        }
      }
    ]
  }
  ```
</ResponseExample>