ウェブサイトのトラフィックアナリティクス
GET /v2/apps//network/analytics でアプリケーションのドメインのエッジトラフィックアナリティクスを取得します: リクエスト、帯域幅、訪問者、各種内訳。
GET
ウェブサイトのトラフィックアナリティクス
apps:read スコープを持つ API キーが必要です。
アナリティクスは、アプリケーションのデフォルトの squareweb.app ドメインおよび割り当てられたカスタムドメインに対する Cloudflare のエッジトラフィックを集計します。リクエスト数、帯域幅、訪問者数に加え、国、デバイス、OS、ブラウザ、プロトコル、メソッド、パス、リファラー、クライアントネットワークごとの内訳が含まれます。生のリクエストログを取得せずに、トラフィックダッシュボードを構築したり異常なパターンを検出したりするのに利用できます。
結果は 5 分単位のバケットでキャッシュされるため、同じウィンドウを繰り返しポーリングしてもコストは低く抑えられます。キャッシュミスは、analytics、errors、logs、performance の各エンドポイント全体で、アプリケーションのオーナーごとに 60 秒あたり 20 リクエストの共通の制限を共有します。キャッシュされたレスポンスはカウントされません。プラットフォーム全体が混雑している時間帯は、代わりに要求されたウィンドウの最新のキャッシュデータを返す場合があります。最大の遡及期間は 7 日間で、実際の開始時刻はアプリケーションの作成日にクランプされます。ネットワークログやネットワークパフォーマンスとは異なり、このエンドポイントは Pro と Enterprise に限らず、すべてのプランで利用できます。
全体のトラフィックではなくエラーに絞ったトラフィックを確認したい場合は、ネットワークエラーを参照してください。デプロイ後にキャッシュされたエッジレスポンスをパージするには、キャッシュのパージを参照してください。
パラメータ
string
必須
アプリケーションの ID。アプリケーションのダッシュボードの URL から確認できます。
string
必須
分析ウィンドウの ISO 8601 開始タイムスタンプ。最大保持期間は 7 日間で、開始日時はアプリケーションの作成日にクランプされます。
string
必須
ISO 8601 終了タイムスタンプ。
start より後である必要があります。ドリルダウンフィルター
すべてのブレークダウンを一致するトラフィックに絞り込むオプションのフィルター。前回のレスポンスで対応するブレークダウンから返された正確なtype の値をそのまま渡してください。フィルターは AND で結合されます。
string
単一のクライアント国(2 文字コード)。
countries ブレークダウンで返される値。string
単一のクライアント IP(IPv4/IPv6 の完全一致)。
ips ブレークダウンで返される値。string
このプレフィックスで始まるリクエストパス(例:
/api は /api/* を対象とする)。最大 256 文字。string
単一のエッジレスポンスステータスコード(3 桁)。
status_codes ブレークダウンで返される値。string
単一のクライアント OS。
os ブレークダウンで返される値。string
単一のクライアントブラウザ。
browsers ブレークダウンで返される値。string
単一の HTTP プロトコル。
protocols ブレークダウンで返される値。string
単一のリファラーホスト。
referers ブレークダウンで返される値(Direct = リファラーなし)。string
単一のクライアントネットワーク。
providers ブレークダウンが返す type の値をそのまま指定します。例: GOOGLE (15169)。単なる ASN 番号や SQUARE-CLOUD-PLATFORM も使用できます。それ以外の値は INVALID_FILTER を返します。string
単一のレスポンスコンテンツタイプ。
content_types ブレークダウンで返される値(Unknown = 未分類)。string
単一の検証済みボットカテゴリ。
bots ブレークダウンで返される値(Unverified = 通常の非ボットトラフィック)。レスポンス
このルートは、データ転送を最適化するため圧縮形式でレスポンスを送信する場合があります。
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。object
各ブレークダウンはバケットの配列です。
type はディメンションを識別し、visits はユニーク訪問者数、requests はリクエスト数、bytes は提供されたレスポンスのバイト数、date は 15 分ウィンドウの開始時刻です。ips、status_codes、bots、content_types の各ブレークダウンはウィンドウ全体の合計(ウィンドウ全体での上位 N 件)であり、date フィールドを持ちません。要求されたウィンドウがアプリケーションの作成日より前に始まる場合は、空のオブジェクト({})を返します。一般的なエラー
関連項目
- CLI:
squarecloud app network analytics - SDK:
api.apps.network.analytics()(JavaScript),client.apps.network.analytics()(Python),c.Apps.Network.Analytics()(Go)

