Obter detalhamento de erros na borda

GET

apps

{app_id}

network

errors

Obter detalhamento de erros na borda

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/network/errors \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/network/errors"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/network/errors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/apps/{app_id}/network/errors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/apps/{app_id}/network/errors"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/network/errors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": {
    "summary": {
      "total": 42,
      "by_class": {
        "4xx": 0,
        "5xx": 42
      }
    },
    "by_status": [
      { "status": 502, "requests": 30 },
      { "status": 504, "requests": 12 }
    ],
    "timeseries": [
      {
        "date": "2025-12-01T12:00:00.000Z",
        "buckets": { "502": 5, "504": 2 },
        "total": 7
      }
    ],
    "top_paths": [
      {
        "path": "/api/users",
        "method": "GET",
        "total": 18,
        "by_status": { "502": 15, "504": 3 }
      }
    ],
    "by_method": [
      {
        "method": "GET",
        "total": 30,
        "by_status": { "502": 22, "504": 8 }
      }
    ]
  }
}

Retorna contagens agregadas de erros servidos na borda da aplicação em uma janela de tempo, agrupados por código de status, intervalo temporal, caminho da requisição e método HTTP. Por padrão somente respostas 5xx são incluídas; envie include_4xx=true para contar também as 4xx.

O cache miss compartilha um limite único de 20 requisições por 60 segundos por proprietário da aplicação, entre os endpoints de análise, erros, logs e performance. Respostas em cache não contam. Em períodos de alta demanda em toda a plataforma, o endpoint pode retornar os dados em cache mais recentes da janela solicitada. Retorna um resumo vazio quando não há erros no período ou quando a janela é anterior à data de criação da aplicação.

string

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

Requer uma chave de API com o escopo apps:read. Como os erros 4xx incluem acessos causados pelo próprio cliente, como sondagens de scanners e links expirados, eles são excluídos por padrão; habilite include_4xx=true apenas quando precisar especificamente desse ruído, por exemplo ao auditar tráfego de bots. Códigos 5xx refletem problemas na borda ou na própria aplicação, então sempre são incluídos. Este endpoint está disponível em todos os planos, assim como Análise de rede. Se você precisar de detalhes por requisição em vez de contagens agregadas, veja Logs de rede (apenas Pro e Enterprise). Para latência em vez de taxa de erro, veja Performance de rede.

Parâmetros

string

obrigatório

O ID da aplicação. Você pode encontrá-lo na URL da sua aplicação no dashboard.

string

obrigatório

Timestamp inicial em formato ISO 8601 para a janela de análise.

string

obrigatório

Timestamp final em formato ISO 8601. Deve ser posterior ao start.

string

Define se respostas 4xx devem ser incluídas junto das 5xx. Aceita true ou false. O padrão é false.

Resposta

string

Indica se a chamada foi bem-sucedida: success se foi, error se não.

object

Resumo agregado dos erros na janela analisada.

Mostrar Alternar objeto response

object

Totais agregados da janela.

Mostrar Alternar objeto summary

integer

Total de respostas de erro na janela.

object

Totais separados por classe de status HTTP.

Mostrar Alternar objeto by_class

integer

Total de respostas 4xx (preenchido apenas quando include_4xx=true).

integer

Total de respostas 5xx.

array

Quantidade de requisições agrupadas por cada código de status HTTP observado.

Mostrar Alternar item by_status

integer

Código de status HTTP (ex. 502, 504).

integer

Total de requisições que retornaram este status.

array

Contagens distribuídas em intervalos temporais ao longo da janela.

Mostrar Alternar item timeseries

string

Timestamp inicial do intervalo, em formato ISO 8601.

object

Objeto cujas chaves são códigos de status HTTP, com a contagem observada no intervalo.

integer

Total de erros observados no intervalo.

array

Caminhos que produziram mais erros na janela.

Mostrar Alternar item top_paths

string

Caminho da requisição.

string

Método HTTP.

integer

Total de erros para este caminho/método.

object

Contagens por código de status HTTP observado para este caminho/método.

array

Totais agregados de erros agrupados por método HTTP.

Mostrar Alternar item by_method

string

Método HTTP.

integer

Total de erros para este método.

object

Contagens por código de status HTTP observado para este método.

{
  "status": "success",
  "response": {
    "summary": {
      "total": 42,
      "by_class": {
        "4xx": 0,
        "5xx": 42
      }
    },
    "by_status": [
      { "status": 502, "requests": 30 },
      { "status": 504, "requests": 12 }
    ],
    "timeseries": [
      {
        "date": "2025-12-01T12:00:00.000Z",
        "buckets": { "502": 5, "504": 2 },
        "total": 7
      }
    ],
    "top_paths": [
      {
        "path": "/api/users",
        "method": "GET",
        "total": 18,
        "by_status": { "502": 15, "504": 3 }
      }
    ],
    "by_method": [
      {
        "method": "GET",
        "total": 30,
        "by_status": { "502": 22, "504": 8 }
      }
    ]
  }
}

Erros comuns

Código	HTTP	Significado
`INVALID_TIME_RANGE`	400	`start`/`end` estão ausentes, malformados ou invertem o intervalo de tempo.
`RATE_LIMITED`	429	O limite compartilhado de cache misses foi atingido. Aguarde e tente novamente.
`UNABLE_TO_FETCH_ERRORS`	500	Falha ao obter os dados de erro do provedor de edge.
`ANALYTICS_BUSY`	503	As análises de borda estão temporariamente ocupadas. Tente novamente em um minuto.

Relacionados

CLI: squarecloud app network errors
SDKs: api.apps.network.errors() (JavaScript), client.apps.network.errors() (Python), c.Apps.Network.Errors() (Go)

Obter detalhamento de erros na borda

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/network/errors \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/network/errors"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/network/errors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/apps/{app_id}/network/errors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/apps/{app_id}/network/errors"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/network/errors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": {
    "summary": {
      "total": 42,
      "by_class": {
        "4xx": 0,
        "5xx": 42
      }
    },
    "by_status": [
      { "status": 502, "requests": 30 },
      { "status": 504, "requests": 12 }
    ],
    "timeseries": [
      {
        "date": "2025-12-01T12:00:00.000Z",
        "buckets": { "502": 5, "504": 2 },
        "total": 7
      }
    ],
    "top_paths": [
      {
        "path": "/api/users",
        "method": "GET",
        "total": 18,
        "by_status": { "502": 15, "504": 3 }
      }
    ],
    "by_method": [
      {
        "method": "GET",
        "total": 30,
        "by_status": { "502": 22, "504": 8 }
      }
    ]
  }
}

Primeiros passos

Conta

Aplicações

Bancos de dados

Workspaces

IA

Obter detalhamento de erros na borda

Parâmetros

Resposta

Erros comuns

Relacionados

​Parâmetros

​Resposta

​Erros comuns

​Relacionados

Parâmetros

Resposta

Erros comuns

Relacionados