> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# ウェブサイトアナリティクス

> Square Cloud でホストされているウェブサイトのアナリティクスを取得します。60 秒あたり 10 件のキャッシュされていないリクエストのレート制限があります。

<ParamField header="Authorization" type="string" placeholder="API Key" required>
  アカウントの API キーです。これは[アカウント設定](https://squarecloud.app/ja/account/security)で確認できます。
</ParamField>

### パラメータ

<ParamField path="app_id" type="string" placeholder="Application ID" required>
  アプリケーションの ID。アプリケーションのダッシュボードの URL から確認できます。
</ParamField>

<ParamField query="start" type="string" placeholder="ISO 8601 timestamp" required>
  分析ウィンドウの ISO 8601 開始タイムスタンプ。最大保持期間は 7 日間で、開始日時はアプリケーションの作成日にクランプされます。
</ParamField>

<ParamField query="end" type="string" placeholder="ISO 8601 timestamp" required>
  ISO 8601 終了タイムスタンプ。`start` より後である必要があります。
</ParamField>

#### ドリルダウンフィルター

**すべての**ブレークダウンを一致するトラフィックに絞り込むオプションのフィルター。前回のレスポンスで対応するブレークダウンから返された正確な `type` の値をそのまま渡してください。フィルターは AND で結合されます。

<ParamField query="country" type="string" placeholder="BR">
  単一のクライアント国（2 文字コード）。`countries` ブレークダウンで返される値。
</ParamField>

<ParamField query="ip" type="string" placeholder="203.0.113.45">
  単一のクライアント IP（IPv4/IPv6 の完全一致）。`ips` ブレークダウンで返される値。
</ParamField>

<ParamField query="path" type="string" placeholder="/api">
  このプレフィックスで始まるリクエストパス（例: `/api` は `/api/*` を対象とする）。最大 256 文字。
</ParamField>

<ParamField query="status" type="string" placeholder="404">
  単一のエッジレスポンスステータスコード（3 桁）。`status_codes` ブレークダウンで返される値。
</ParamField>

<ParamField query="os" type="string" placeholder="Windows">
  単一のクライアント OS。`os` ブレークダウンで返される値。
</ParamField>

<ParamField query="browser" type="string" placeholder="Chrome">
  単一のクライアントブラウザ。`browsers` ブレークダウンで返される値。
</ParamField>

<ParamField query="protocol" type="string" placeholder="HTTP/2">
  単一の HTTP プロトコル。`protocols` ブレークダウンで返される値。
</ParamField>

<ParamField query="referer" type="string" placeholder="google.com">
  単一のリファラーホスト。`referers` ブレークダウンで返される値（`Direct` = リファラーなし）。
</ParamField>

<ParamField query="provider" type="string" placeholder="GOOGLE (15169)">
  単一のクライアントネットワーク。`providers` ブレークダウンで返される値。例: `GOOGLE (15169)`、単なる ASN 番号、または `SQUARE-CLOUD-PLATFORM`。
</ParamField>

<ParamField query="content_type" type="string" placeholder="json">
  単一のレスポンスコンテンツタイプ。`content_types` ブレークダウンで返される値（`Unknown` = 未分類）。
</ParamField>

<ParamField query="bot" type="string" placeholder="Search Engine Crawler">
  単一の検証済みボットカテゴリ。`bots` ブレークダウンで返される値（`Unverified` = 通常の非ボットトラフィック）。
</ParamField>

### レスポンス

<Info>
  このルートは、データ転送を最適化するため圧縮形式でレスポンスを送信する場合があります。
</Info>

<ResponseField name="status" type="string">
  呼び出しが成功したかどうかを示します。成功した場合は `success`、失敗した場合は `error` です。
</ResponseField>

<ResponseField name="response" type="object">
  各ブレークダウンはバケットの配列です。`type` はディメンションを識別し、`visits` はユニーク訪問者数、`requests` はリクエスト数、`bytes` は提供されたレスポンスのバイト数、`date` は 15 分ウィンドウの開始時刻です。`ips`、`status_codes`、`bots`、`content_types` の各ブレークダウンはウィンドウ全体の合計（ウィンドウ全体での上位 N 件）であり、`date` フィールドを**持ちません**。要求されたウィンドウがアプリケーションの作成日より前に始まる場合は、空のオブジェクト（`{}`）を返します。
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
    "status": "success",
    "response": {
      "visits": [
        { "visits": 1024, "requests": 1247, "bytes": 8421000, "date": "2026-05-21T10:00:00Z" }
      ],
      "countries": [
        { "type": "BR", "visits": 612, "requests": 743, "bytes": 5012000, "date": "2026-05-21T10:00:00Z" }
      ],
      "devices": [
        { "type": "desktop", "visits": 820, "requests": 998, "bytes": 6700000, "date": "2026-05-21T10:00:00Z" }
      ],
      "os": [
        { "type": "Windows", "visits": 540, "requests": 651, "bytes": 4400000, "date": "2026-05-21T10:00:00Z" }
      ],
      "browsers": [
        { "type": "Chrome", "visits": 720, "requests": 870, "bytes": 5800000, "date": "2026-05-21T10:00:00Z" }
      ],
      "protocols": [
        { "type": "HTTP/2", "visits": 900, "requests": 1100, "bytes": 7400000, "date": "2026-05-21T10:00:00Z" }
      ],
      "methods": [
        { "type": "GET", "visits": 850, "requests": 1020, "bytes": 6900000, "date": "2026-05-21T10:00:00Z" }
      ],
      "paths": [
        { "type": "/", "visits": 410, "requests": 498, "bytes": 3320000, "date": "2026-05-21T10:00:00Z" }
      ],
      "referers": [
        { "type": "Direct", "visits": 380, "requests": 462, "bytes": 3100000, "date": "2026-05-21T10:00:00Z" }
      ],
      "providers": [
        { "type": "AS15169 (GOOGLE)", "visits": 210, "requests": 254, "bytes": 1700000, "date": "2026-05-21T10:00:00Z" }
      ],
      "ips": [
        { "type": "203.0.113.45", "visits": 40, "requests": 3120, "bytes": 2100000 }
      ],
      "status_codes": [
        { "type": "200", "visits": 950, "requests": 1180, "bytes": 8100000 }
      ],
      "bots": [
        { "type": "Search Engine Crawler", "visits": 0, "requests": 84, "bytes": 410000 }
      ],
      "content_types": [
        { "type": "json", "visits": 310, "requests": 720, "bytes": 4200000 }
      ]
    }
  }
  ```
</ResponseExample>