Skip to main content

文档说明

本文包含两类接口:AI 代码指标(聚合统计、排名、仓库与扩展名等)与 AI 代码追踪(Commit / Change 明细与 CSV 导出)。二者分页方式不同,请注意各节说明。调用前请完成 获取 API Key,并阅读 约定与规范。

权限要求

  • 使用有效的 API Key(Authorization: Bearer)。
  • API Key 必须关联到目标组织。

概述

AI 代码指标 API 提供组织级别的 AI 辅助编码统计数据,包括代码统计概览、每日趋势、成员排名、仓库列表和文件扩展名统计。

主要功能

  • 统计概览: 提交代码中 AI 贡献的总量和占比
  • 每日趋势: 按天查看 AI 代码占比、Agent 代码分语言统计、Tab 补全接受率
  • 成员排名: 按 AI 代码贡献量排名成员
  • 仓库列表: 列出有 AI 代码活动的仓库
  • 文件扩展名: 按文件类型统计 AI 代码指标
  • 提交详情: 获取提交级别的 AI 代码归因详情(文件级行范围注解)

通用查询参数

以下参数适用于所有 AI Code 接口(各接口的必填性见具体说明):

API 列表

1. 获取 AI 代码统计概览

GET /v1/organizations/{organization_id}/ai-code/stats/overview 获取组织 AI 代码的整体统计数据。

路径参数

查询参数

见「通用查询参数」,其中:
start_date 和 end_date 均为必填,且时间范围不超过 90 天。

成功响应 (200 OK)

响应字段说明


2. 获取 AI 代码每日趋势

GET /v1/organizations/{organization_id}/ai-code/stats/daily-trend 获取 AI 代码的每日趋势数据,包含三组数据:AI 代码占比趋势、按语言分布趋势、Tab 补全接受率趋势。

路径参数

查询参数

见「通用查询参数」,其中:
start_date 和 end_date 均为必填,且时间范围不超过 90 天。

成功响应 (200 OK)

响应字段说明

items[ ] - AI 代码占比趋势(Chart 1) extItems[ ] - Agent 代码按语言分布趋势(Chart 2) nextItems[ ] - Tab 补全接受率趋势(Chart 3)

3. 获取成员 AI 代码排名

GET /v1/organizations/{organization_id}/ai-code/stats/member-ranking 获取组织成员按 AI 代码贡献量的排名。

路径参数

查询参数

见「通用查询参数」,其中:
start_date 和 end_date 均为必填,且时间范围不超过 90 天。
额外支持:

成功响应 (200 OK)

响应字段说明


4. 列出仓库

GET /v1/organizations/{organization_id}/ai-code/repos 列出组织中有 AI 代码活动的仓库。

路径参数

查询参数

成功响应 (200 OK)

响应字段说明


5. 列出文件扩展名

GET /v1/organizations/{organization_id}/ai-code/file-extensions 列出组织中有 AI 代码活动的文件扩展名统计。

路径参数

查询参数

成功响应 (200 OK)

响应字段说明


6. 获取提交 AI 归因详情

POST /v1/organizations/{organization_id}/ai-code-tracking/commits/detail 批量获取提交级别的 AI 代码归因详情,包含文件级的行范围注解。

路径参数

请求体 (JSON)

请求示例

成功响应 (200 OK)

响应字段说明


使用示例

获取统计概览

获取每日趋势(指定仓库和主分支)

获取成员排名(前 20)

搜索仓库

获取文件扩展名统计

获取提交 AI 归因详情


错误码

错误响应结构见 约定与规范 中的「错误响应」一节。

AI 代码追踪 API

在 AI 代码指标(聚合统计)之外,本节提供 Commit / Change 级别的明细查询与 CSV 导出。鉴权方式与上文相同:Authorization: Bearer <api_key>。 使用前请确认组织已开通与控制台一致的 AI 代码数据分析 能力;若未开通或无权访问,接口可能返回 403 等错误,以实际响应为准。字段与枚举以线上接口与 OpenAPI 定义为准,本文仅作说明。

追踪能力说明

AI 代码追踪 API 提供 commit 级别和 change 级别的逐条明细查询与 CSV 导出能力,是对上文 AI 代码指标(聚合统计)的补充。

两层数据模型

Change 是尚未 git commit 的 IDE 内事件,因此不具有 repoName / branchName 维度。

产品 x 场景交叉分解(Commit 级别)

每条 commit 记录包含 12 对 linesAdded / linesDeleted 列,按「产品 x 场景」交叉拆解 AI 代码行:

主要功能

  • Commit 明细查询: 逐条列出提交级 AI 代码统计(含产品 x 场景拆解)
  • Commit CSV 导出: 流式导出全部 commit 数据
  • Change 明细查询: 逐条列出 IDE 内 AI 代码编辑事件(支持按 source 过滤)
  • Change CSV 导出: 流式导出全部 change 数据
  • 用户邮箱: 列表与导出中会尽量填充 userEmail(若数据中存在)
  • 按邮箱筛选: 支持通过 userEmail 查询参数定位用户

分页方式

Tracking API 使用偏移量分页(page + pageSize),不同于其他接口常用的游标分页。响应包含 totalItems / totalPages,便于分页展示。

通用查询参数

以下参数适用于所有 Tracking 接口:
userId 和 userEmail 同时提供时,userId 优先。

API 列表

1. 列出 Commit 明细

GET /v1/organizations/{organization_id}/ai-code-tracking/commits 逐条列出提交级 AI 代码统计数据,按提交时间倒序排列。每条记录包含产品 x 场景的交叉拆解。

路径参数

查询参数

见「通用查询参数」,额外支持:

成功响应 (200 OK)

响应字段说明

success - true 表示请求成功 data.items[ ] - Commit 明细列表 data.pagination - 分页信息

2. 导出 Commit CSV

GET /v1/organizations/{organization_id}/ai-code-tracking/commits/export 以流式 CSV 格式导出 commit 数据。导出过程由服务端自动完成分页聚合,调用方无需自行翻页。

路径参数

查询参数

见「通用查询参数」,额外支持:

成功响应 (200 OK)

  • Content-Type: text/csv; charset=utf-8
  • Content-Disposition: attachment; filename="ai-code-commits.csv"
CSV 列头(注意 CSV 保留 userName,JSON 响应中已移除):

3. 列出 Change 明细

GET /v1/organizations/{organization_id}/ai-code-tracking/changes 逐条列出 IDE 内 AI 代码编辑事件(仅 action=suggested 的记录),按事件时间倒序排列。
Change 是尚未 git commit 的 IDE 内事件,因此不支持 repoName 过滤。

路径参数

查询参数

见「通用查询参数」,额外支持:

成功响应 (200 OK)

响应字段说明

success - true 表示请求成功 data.items[ ] - Change 明细列表 data.pagination - 分页信息

4. 导出 Change CSV

GET /v1/organizations/{organization_id}/ai-code-tracking/changes/export 以流式 CSV 格式导出 change 数据。导出过程由服务端自动完成分页聚合,调用方无需自行翻页。
CSV 导出为扁平格式,不包含 metadata(文件级明细)。

路径参数

查询参数

见「通用查询参数」,额外支持:

成功响应 (200 OK)

  • Content-Type: text/csv; charset=utf-8
  • Content-Disposition: attachment; filename="ai-code-changes.csv"
CSV 列头:

使用示例

查询 commit 明细(按仓库过滤)

按邮箱查询用户的 commit

导出 commit CSV

查询 change 明细(按 source 过滤)

导出 change CSV


错误码

错误响应结构见 约定与规范 中的「错误响应」一节。