Network Errors - Square Cloud

GET

apps

{app_id}

network

errors

Network Errors

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))

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/{app_id}/network/errors")
  .header("Authorization", "<authorization>")
  .asString();

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

Returns aggregated edge error counts for the application over a time window, grouped by status code, time bucket, request path and HTTP method. By default only 5xx responses are included; pass include_4xx=true to also count 4xx responses.

Cache miss rate limit: 15 requests per 60 seconds per owner. Returns an empty breakdown when there are no matching errors or when the window precedes the application’s creation date.

Authorization

string

required

The API key for your account. You can find this in your account settings.

Because 4xx errors include client-caused hits like scanner probes and expired links, they are excluded by default; enable include_4xx=true only when you specifically need that noise, for example while auditing bot traffic. 5xx codes reflect problems at the edge or the application itself, so they are always included. This endpoint is available on every paid plan, the same as Network Analytics. If you need per-request detail instead of aggregated counts, see Network Logs (Pro and Enterprise only). For latency instead of error rate, see Network Performance.

Parameters

app_id

string

required

The ID of the application. You can find this in the URL of your application’s dashboard.

start

string

required

ISO 8601 start timestamp for the analysis window.

end

string

required

ISO 8601 end timestamp. Must be after start.

include_4xx

string

Whether to include 4xx responses alongside 5xx errors. Accepts true or false. Defaults to false.

Response

status

string

Indicates whether the call was successful.. success if successful, error if not.

response

object

Aggregated error breakdown for the window.

Show Toggle response object

summary

object

High-level totals for the window.

Show Toggle summary object

total

integer

Total number of error responses in the window.

by_class

object

Totals split by HTTP status class.

Show Toggle by_class object

4xx

integer

Total 4xx responses (only populated when include_4xx=true).

5xx

integer

Total 5xx responses.

by_status

array

Number of requests grouped by each individual HTTP status code observed.

Show Toggle by_status item

status

integer

HTTP status code (e.g. 502, 504).

requests

integer

Total requests that returned this status code.

timeseries

array

Time-bucketed counts across the analysis window.

Show Toggle timeseries item

date

string

Bucket start timestamp in ISO 8601 format.

buckets

object

Object keyed by HTTP status code with the count observed in this bucket.

total

integer

Total errors observed in this bucket.

top_paths

array

Paths that produced the most errors during the window.

Show Toggle top_paths item

path

string

Request path.

method

string

HTTP method.

total

integer

Total errors for this path/method.

by_status

object

Counts per HTTP status code observed for this path/method.

by_method

array

Aggregated error totals grouped by HTTP method.

Show Toggle by_method item

method

string

HTTP method.

total

integer

Total errors for this method.

by_status

object

Counts per HTTP status code observed for this method.

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

Common errors

Code	HTTP	Meaning
`INVALID_TIME_RANGE`	400	`start`/`end` are missing, malformed, or invert the time range.
`UNABLE_TO_FETCH_ERRORS`	500	Failed to fetch error data from the edge provider.

Network PerformanceGet edge and origin latency percentiles with country, colo and path breakdowns for the application.

Network Errors

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))

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/{app_id}/network/errors")
  .header("Authorization", "<authorization>")
  .asString();

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

​Parameters

​Response

​Common errors

Parameters

Response

Common errors