エッジエラーの内訳取得

GET

apps

{app_id}

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

}

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

指定した期間におけるアプリケーションのエッジエラー数を集計し、ステータスコード、時間バケット、リクエストパス、HTTP メソッドごとにグループ化して返します。デフォルトでは 5xx レスポンスのみが対象です。4xx レスポンスもカウントするには include_4xx=true を指定してください。

キャッシュミスは、analytics、errors、logs、performance の各エンドポイント全体で、アプリケーションのオーナーごとに 60 秒あたり 20 リクエストの共通の制限を共有します。キャッシュされたレスポンスはカウントされません。プラットフォーム全体が混雑している時間帯は、代わりに要求されたウィンドウの最新のキャッシュデータを返す場合があります。該当するエラーがない場合、または期間がアプリケーションの作成日より前の場合は、空の内訳を返します。

string

必須

アカウントの API キーです。これはアカウント設定で確認できます。

apps:read スコープを持つ API キーが必要です。 4xx エラーにはスキャナーによるプローブや期限切れリンクへのアクセスなど、クライアント起因のヒットが含まれるため、デフォルトでは除外されます。ボットトラフィックの監査時など、そのノイズが特に必要な場合にのみ include_4xx=true を有効にしてください。5xx コードはエッジまたはアプリケーション自体の問題を反映するため、常に含まれます。このエンドポイントは、ウェブサイトアナリティクスと同様にすべてのプランで利用できます。集計されたカウントではなくリクエスト単位の詳細が必要な場合は、ネットワークログ(Pro および Enterprise 限定)を参照してください。エラー率ではなくレイテンシを確認したい場合は、ネットワークパフォーマンスを参照してください。

パラメータ

string

必須

アプリケーションのID。アプリケーションのダッシュボードのURLで確認できます。

string

必須

分析期間の ISO 8601 形式の開始タイムスタンプ。

string

必須

ISO 8601 形式の終了タイムスタンプ。start より後である必要があります。

string

5xx エラーに加えて 4xx レスポンスを含めるかどうか。true または false を指定します。デフォルトは false です。

レスポンス

string

呼び出しが成功したかどうかを示します。成功した場合は success、失敗した場合は error です。

object

期間内の集計されたエラー内訳。

表示レスポンスオブジェクトを切り替え

object

期間内の概要合計。

表示 summary オブジェクトを切り替え

integer

期間内のエラーレスポンスの総数。

object

HTTP ステータスクラスごとに分類した合計。

表示 by_class オブジェクトを切り替え

integer

4xx レスポンスの合計(include_4xx=true の場合のみ設定されます)。

integer

5xx レスポンスの合計。

array

観測された個々の HTTP ステータスコードごとにグループ化したリクエスト数。

表示 by_status 項目を切り替え

integer

HTTP ステータスコード(例: 502、504)。

integer

このステータスコードを返したリクエストの総数。

array

分析期間全体にわたる時間バケット単位のカウント。

表示 timeseries 項目を切り替え

string

ISO 8601 形式のバケット開始タイムスタンプ。

object

HTTP ステータスコードをキーとし、このバケットで観測されたカウントを値とするオブジェクト。

integer

このバケットで観測されたエラーの総数。

array

期間中に最も多くのエラーを発生させたパス。

表示 top_paths 項目を切り替え

string

リクエストパス。

string

HTTP メソッド。

integer

このパス/メソッドのエラー総数。

object

このパス/メソッドで観測された HTTP ステータスコードごとのカウント。

array

HTTP メソッドごとにグループ化した集計エラー総数。

表示 by_method 項目を切り替え

string

HTTP メソッド。

integer

このメソッドのエラー総数。

object

このメソッドで観測された HTTP ステータスコードごとのカウント。

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

一般的なエラー

コード	HTTP	説明
`INVALID_TIME_RANGE`	400	`start`/`end` が指定されていない、形式が不正、または時間範囲が逆転しています。
`RATE_LIMITED`	429	キャッシュミスの共有上限に達しました。しばらく待ってから再試行してください。
`UNABLE_TO_FETCH_ERRORS`	500	エッジプロバイダーからのエラーデータ取得に失敗しました。
`ANALYTICS_BUSY`	503	エッジアナリティクスが一時的に混雑しています。1 分後に再試行してください。

関連項目

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

エッジエラーの内訳取得

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

はじめに

アカウント

アプリケーション

データベース

ワークスペース

AI

エッジエラーの内訳取得

パラメータ

レスポンス

一般的なエラー

関連項目

​パラメータ

​レスポンス

​一般的なエラー

​関連項目

パラメータ

レスポンス

一般的なエラー

関連項目