> ## 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/zh/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` 分类明细中所返回。
</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">
  单个来源（referer）主机，如 `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">
  每一项分类明细都是一个桶（bucket）数组。`type` 标识维度，`visits` 是独立访客数，`requests` 是请求数，`bytes` 是所服务的响应字节数，`date` 是 15 分钟窗口的起始时间。`ips`、`status_codes`、`bots` 和 `content_types` 这几项分类明细为窗口总计（整个窗口内的 top-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>