Obtenir la répartition des erreurs edge

GET

apps

{app_id}

network

errors

Obtenir la répartition des erreurs edge

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 }
      }
    ]
  }
}

Renvoie le nombre agrégé d’erreurs edge de l’application sur une fenêtre temporelle, groupé par code de statut, intervalle de temps, chemin de requête et méthode HTTP. Par défaut, seules les réponses 5xx sont incluses ; passez include_4xx=true pour comptabiliser également les réponses 4xx.

Les cache miss partagent une limite unique de 20 requêtes par 60 secondes par propriétaire de l’application, entre les endpoints analytics, erreurs, logs et performance. Les réponses en cache ne sont pas comptabilisées. Lors des périodes de forte charge sur l’ensemble de la plateforme, l’endpoint peut renvoyer à la place les données en cache les plus récentes pour la fenêtre demandée. Renvoie une répartition vide lorsqu’il n’y a aucune erreur correspondante ou lorsque la fenêtre précède la date de création de l’application.

string

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Nécessite une clé API avec le scope apps:read. Les erreurs 4xx incluant des hits causés par le client, comme les sondes de scanners ou les liens expirés, elles sont exclues par défaut ; n’activez include_4xx=true que lorsque vous avez spécifiquement besoin de ce bruit, par exemple lors d’un audit de trafic de bots. Les codes 5xx reflètent des problèmes au niveau de l’edge ou de l’application elle-même, ils sont donc toujours inclus. Cet endpoint est disponible sur tous les plans, comme Analytics de site web. Si vous avez besoin de détails par requête plutôt que de décomptes agrégés, voir Logs réseau (Pro et Enterprise uniquement). Pour la latence plutôt que le taux d’erreur, voir Performance réseau.

Paramètres

string

requis

L’ID de l’application. Vous pouvez le trouver dans l’URL du tableau de bord de votre application.

string

requis

Horodatage de début ISO 8601 pour la fenêtre d’analyse.

string

requis

Horodatage de fin ISO 8601. Doit être postérieur à start.

string

Indique s’il faut inclure les réponses 4xx en plus des erreurs 5xx. Accepte true ou false. Par défaut false.

Réponse

string

Indique si l’appel a réussi : success si c’est le cas, error sinon.

object

Répartition agrégée des erreurs pour la fenêtre.

Afficher Afficher l'objet de réponse

object

Totaux globaux pour la fenêtre.

Afficher Afficher l'objet summary

integer

Nombre total de réponses en erreur dans la fenêtre.

object

Totaux répartis par classe de statut HTTP.

Afficher Afficher l'objet by_class

integer

Total des réponses 4xx (renseigné uniquement lorsque include_4xx=true).

integer

Total des réponses 5xx.

array

Nombre de requêtes groupées par chaque code de statut HTTP individuel observé.

Afficher Afficher l'élément by_status

integer

Code de statut HTTP (par ex. 502, 504).

integer

Nombre total de requêtes ayant renvoyé ce code de statut.

array

Décomptes par intervalle de temps sur la fenêtre d’analyse.

Afficher Afficher l'élément timeseries

string

Horodatage de début de l’intervalle au format ISO 8601.

object

Objet indexé par code de statut HTTP avec le décompte observé dans cet intervalle.

integer

Total des erreurs observées dans cet intervalle.

array

Chemins ayant produit le plus d’erreurs durant la fenêtre.

Afficher Afficher l'élément top_paths

string

Chemin de la requête.

string

Méthode HTTP.

integer

Total des erreurs pour ce chemin/cette méthode.

object

Décomptes par code de statut HTTP observé pour ce chemin/cette méthode.

array

Totaux d’erreurs agrégés groupés par méthode HTTP.

Afficher Afficher l'élément by_method

string

Méthode HTTP.

integer

Total des erreurs pour cette méthode.

object

Décomptes par code de statut HTTP observé pour cette méthode.

{
  "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 }
      }
    ]
  }
}

Erreurs courantes

Code	HTTP	Signification
`INVALID_TIME_RANGE`	400	`start`/`end` sont manquants, mal formés, ou inversent la plage temporelle.
`RATE_LIMITED`	429	La limite partagée des cache miss a été atteinte. Patientez puis réessayez.
`UNABLE_TO_FETCH_ERRORS`	500	Échec de la récupération des données d’erreur depuis le fournisseur edge.
`ANALYTICS_BUSY`	503	Les analytics edge sont temporairement surchargés. Réessayez dans une minute.

Voir aussi

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

Obtenir la répartition des erreurs edge

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 }
      }
    ]
  }
}

Premiers pas

Compte

Applications

Bases de données

Workspaces

IA

Obtenir la répartition des erreurs edge

Paramètres

Réponse

Erreurs courantes

Voir aussi

​Paramètres

​Réponse

​Erreurs courantes

​Voir aussi

Paramètres

Réponse

Erreurs courantes

Voir aussi