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

# 获取 Cascade Analytics

> 查询 Cascade 专属的使用指标，包括建议/接受的代码行数、AI 模型使用情况、额度消耗以及工具使用统计。

<div id="overview">
  ## 概览
</div>

获取 Cascade 专属的 Analytics 数据，包括建议/接受的代码行数、AI 模型使用情况、额度消耗以及工具使用统计。

<div id="request">
  ## 请求
</div>

<ParamField body="service_key" type="string" required>
  具备 "Teams Read-only" 权限的服务密钥
</ParamField>

<ParamField body="group_name" type="string">
  将结果限定为特定群组中的用户。不可与 `emails` 参数同时使用。
</ParamField>

<ParamField body="start_timestamp" type="string">
  开始时间，采用 RFC 3339 格式（例如：`2023-01-01T00:00:00Z`）
</ParamField>

<ParamField body="end_timestamp" type="string">
  结束时间，采用 RFC 3339 格式（例如：`2023-12-31T23:59:59Z`）
</ParamField>

<ParamField body="emails" type="array">
  用于筛选结果的电子邮箱地址数组。不可与 `group_name` 参数同时使用。
</ParamField>

<ParamField body="ide_types" type="array">
  按 IDE 类型筛选。可选值：

  * `"editor"` - Windsurf Editor
  * `"jetbrains"` - JetBrains 插件

  如未指定，将返回两种 IDE 的数据。
</ParamField>

<ParamField body="query_requests" type="array" required>
  要执行的数据源查询数组。每个对象应包含一个受支持的数据源。
</ParamField>

<div id="data-sources">
  ## 数据来源
</div>

<div id="cascade_lines">
  ### cascade\_lines
</div>

查询每日由 Cascade 提示和接受的代码行数。

```json theme={null}
{
  "cascade_lines": {}
}
```

**响应字段：**

* `day` - 符合 RFC 3339 的日期
* `linesSuggested` - 建议的行数
* `linesAccepted` - 接收的行数

<div id="cascade_runs">
  ### cascade\_runs
</div>

查询 AI 模型使用情况、额度消耗以及模式相关数据。

```json theme={null}
{
  "cascade_runs": {}
}
```

**响应字段：**

* `day` - RFC 3339 格式的日期
* `model` - 使用的 AI 模型名称
* `mode` - Cascade 模式（见下方模式说明）
* `messagesSent` - 发送的消息数量
* `cascadeId` - 唯一会话 ID
* `promptsUsed` - 消耗的积分（以分为单位）

**Cascade 模式：**

* `CONVERSATIONAL_PLANNER_MODE_DEFAULT` - 写模式
* `CONVERSATIONAL_PLANNER_MODE_READ_ONLY` - 只读模式
* `CONVERSATIONAL_PLANNER_MODE_NO_TOOL` - 旧版模式
* `UNKNOWN` - 未知模式

<div id="cascade_tool_usage">
  ### cascade\_tool\_usage
</div>

用于查询工具使用统计数据（汇总计数）。

```json theme={null}
{
  "cascade_tool_usage": {}
}
```

**响应字段：**

* `tool` - 工具标识符（参见下文的工具映射）
* `count` - 工具使用次数

<div id="tool-usage-mappings">
  ## 工具使用映射
</div>

| Tool Identifier     | 显示名称       |
| ------------------- | ---------- |
| `CODE_ACTION`       | 代码编辑       |
| `VIEW_FILE`         | 查看文件       |
| `RUN_COMMAND`       | 运行 Command |
| `FIND`              | 查找工具       |
| `GREP_SEARCH`       | Grep 搜索    |
| `VIEW_FILE_OUTLINE` | 查看文件大纲     |
| `MQUERY`            | Riptide    |
| `WORKFLOWS_USED`    | 工作流使用情况    |
| `LIST_DIRECTORY`    | 列出目录       |
| `MCP_TOOL`          | MCP 工具     |
| `PROPOSE_CODE`      | 提出代码建议     |
| `SEARCH_WEB`        | 网页搜索       |
| `MEMORY`            | 记忆         |
| `PROXY_WEB_SERVER`  | 浏览器预览      |
| `DEPLOY_WEB_APP`    | 部署 Web 应用  |

<div id="example-request">
  ## 示例请求
</div>

```bash theme={null}
curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "group_name": "engineering_team",
  "start_timestamp": "2025-01-01T00:00:00Z",
  "end_timestamp": "2025-01-02T00:00:00Z",
  "emails": ["user1@windsurf.com", "user2@windsurf.com"],
  "ide_types": ["editor"],
  "query_requests": [
    {
      "cascade_lines": {}
    },
    {
      "cascade_runs": {}
    },
    {
      "cascade_tool_usage": {}
    }
  ]
}' \
https://server.codeium.com/api/v1/CascadeAnalytics
```

<div id="response">
  ## 响应
</div>

<ResponseField name="queryResults" type="array">
  查询结果数组，每个查询请求对应一个查询结果

  <Expandable title="Cascade 行统计结果">
    <ResponseField name="cascadeLines" type="object">
      <ResponseField name="cascadeLines" type="array">
        每日行级统计数组

        <ResponseField name="day" type="string">
          RFC 3339 格式的日期
        </ResponseField>

        <ResponseField name="linesSuggested" type="string">
          当天被建议的代码行数
        </ResponseField>

        <ResponseField name="linesAccepted" type="string">
          当天被接受的代码行数
        </ResponseField>
      </ResponseField>
    </ResponseField>
  </Expandable>

  <Expandable title="Cascade 运行结果">
    <ResponseField name="cascadeRuns" type="object">
      <ResponseField name="cascadeRuns" type="array">
        AI 模型使用统计数组

        <ResponseField name="day" type="string">
          RFC 3339 格式的日期
        </ResponseField>

        <ResponseField name="model" type="string">
          本次运行所使用的 AI 模型名称
        </ResponseField>

        <ResponseField name="mode" type="string">
          Cascade 模式标识符
        </ResponseField>

        <ResponseField name="messagesSent" type="string">
          发送的消息数量
        </ResponseField>

        <ResponseField name="cascadeId" type="string">
          唯一会话标识符
        </ResponseField>

        <ResponseField name="promptsUsed" type="string">
          以分为单位的积分消耗（例如，"100" = 1 个积分）
        </ResponseField>
      </ResponseField>
    </ResponseField>
  </Expandable>

  <Expandable title="Cascade 工具使用结果">
    <ResponseField name="cascadeToolUsage" type="object">
      <ResponseField name="cascadeToolUsage" type="array">
        工具使用统计数组

        <ResponseField name="tool" type="string">
          工具标识符
        </ResponseField>

        <ResponseField name="count" type="string">
          工具被使用的次数
        </ResponseField>
      </ResponseField>
    </ResponseField>
  </Expandable>
</ResponseField>

<div id="example-response">
  ### 示例回复
</div>

```json theme={null}
{
  "queryResults": [
    {
      "cascadeLines": {
        "cascadeLines": [
          {
            "day": "2025-05-01T00:00:00Z",
            "linesSuggested": "206",
            "linesAccepted": "157"
          },
          {
            "day": "2025-05-02T00:00:00Z",
            "linesSuggested": "16"
          }
        ]
      }
    },
    {
      "cascadeRuns": {
        "cascadeRuns": [
          {
            "day": "2025-05-01T00:00:00Z",
            "model": "Claude 3.7 Sonnet (Thinking)",
            "mode": "CONVERSATIONAL_PLANNER_MODE_DEFAULT",
            "messagesSent": "1",
            "cascadeId": "0d35c1f7-0a85-41d0-ac96-a04cd2d64444"
          }
        ]
      }
    },
    {
      "cascadeToolUsage": {
        "cascadeToolUsage": [
          {
            "tool": "CODE_ACTION",
            "count": "15"
          },
          {
            "tool": "LIST_DIRECTORY",
            "count": "20"
          }
        ]
      }
    }
  ]
}
```

<div id="notes">
  ## 注意事项
</div>

* API 返回的是原始数据，其中可能包含 "UNKNOWN" 值
* 进行指标分析时，请按感兴趣的特定字段进行聚合（例如，对 `promptsUsed` 求和以分析使用模式）
* Mode 和 prompt 数据可能会拆分到多条记录中
* 点数消耗（`promptsUsed`）以“分”为单位返回（100 = 1 credit）