REST API 现在已版本化。 更多信息，请参阅“关于 API 版本控制”。

GitHub Copilot 使用指标的 REST API 端点

使用 REST API 访问企业、组织或团队的 Copilot 使用指标。

获取企业成员 Copilot 使用情况摘要

注意

此端点处于公开预览阶段，可能会发生更改。

您可以使用此端点查看企业中所有拥有 Copilot 访问权限的组织用户的 Copilot 代码补全和 Copilot Chat 在 IDE 中的聚合使用指标的每日细分，并进一步按编辑器和语言细分每日建议、接受和活跃用户数量。有关详细的指标定义，请参阅响应模式选项卡。

响应包含最多 28 天前的指标。使用指标每天处理一次前一天的数据，响应中只包含昨天的数据。为了将最终用户计入这些指标，他们必须在其 IDE 中启用遥测。

响应中的时区为 UTC 时间，这意味着“一天”的截止时间为 UTC 时间。

只有所有者和计费管理员才能查看企业的 Copilot 使用指标。

OAuth 应用令牌和个人访问令牌（经典版）需要 `manage_billing:copilot` 或 `read:enterprise` 范围才能使用此端点。

“获取企业成员 Copilot 使用情况摘要”的细粒度访问令牌

此端点不适用于 GitHub 应用用户访问令牌、GitHub 应用安装访问令牌或细粒度个人访问令牌。

“获取企业成员 Copilot 使用情况摘要”的参数

标头
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
enterprise 字符串 必需

企业的名称的slug版本。您也可以用企业ID替换此值。

查询参数
since 字符串

显示自此日期以来的使用指标。这是一个 ISO 8601 格式 (YYYY-MM-DDTHH:MM:SSZ) 的时间戳。最大值为 28 天前。

until 字符串

显示直到此日期的使用指标。这是一个 ISO 8601 格式 (YYYY-MM-DDTHH:MM:SSZ) 的时间戳，如果传递了 `since` 日期，则不应早于 `since` 日期。

page 整数

要获取的结果的页码。更多信息，请参阅“在 REST API 中使用分页”。

默认： 1

per_page 整数

每页显示的指标天数（最大 28 天）。更多信息，请参阅“在 REST API 中使用分页”。

默认： 28

“获取企业成员 Copilot 使用情况摘要”的 HTTP 响应状态代码

状态代码描述
200

OK

401

需要身份验证

403

禁止

404

资源未找到

500

内部错误

“获取企业成员 Copilot 使用情况摘要”的代码示例

请求示例

get/enterprises/{enterprise}/copilot/usage
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/copilot/usage

响应

状态：200
[ { "day": "2023-10-15", "total_suggestions_count": 5000, "total_acceptances_count": 3000, "total_lines_suggested": 7000, "total_lines_accepted": 3500, "total_active_users": 15, "total_chat_acceptances": 45, "total_chat_turns": 350, "total_active_chat_users": 8, "breakdown": [ { "language": "python", "editor": "vscode", "suggestions_count": 3000, "acceptances_count": 2000, "lines_suggested": 3000, "lines_accepted": 1500, "active_users": 5 }, { "language": "python", "editor": "jetbrains", "suggestions_count": 1000, "acceptances_count": 500, "lines_suggested": 2000, "lines_accepted": 1000, "active_users": 5 }, { "language": "javascript", "editor": "vscode", "suggestions_count": 1000, "acceptances_count": 500, "lines_suggested": 2000, "lines_accepted": 1000, "active_users": 5 } ] }, { "day": "2023-10-16", "total_suggestions_count": 5200, "total_acceptances_count": 5100, "total_lines_suggested": 5300, "total_lines_accepted": 5000, "total_active_users": 15, "total_chat_acceptances": 57, "total_chat_turns": 455, "total_active_chat_users": 12, "breakdown": [ { "language": "python", "editor": "vscode", "suggestions_count": 3100, "acceptances_count": 3000, "lines_suggested": 3200, "lines_accepted": 3100, "active_users": 5 }, { "language": "python", "editor": "jetbrains", "suggestions_count": 1100, "acceptances_count": 1000, "lines_suggested": 1200, "lines_accepted": 1100, "active_users": 5 }, { "language": "javascript", "editor": "vscode", "suggestions_count": 1000, "acceptances_count": 900, "lines_suggested": 1100, "lines_accepted": 1000, "active_users": 5 } ] } ]

获取企业团队 Copilot 使用情况摘要

注意

此端点处于公开预览阶段，可能会发生更改。

您可以使用此端点查看企业团队用户的 Copilot 代码补全和 Copilot Chat 在 IDE 中的聚合使用指标的每日细分，并进一步按编辑器和语言细分每日建议、接受和活跃用户数量。有关详细的指标定义，请参阅响应模式选项卡。

响应包含最多 28 天前的指标。使用指标每天处理一次前一天的数据，响应中只包含昨天的数据。为了将最终用户计入这些指标，他们必须在其 IDE 中启用遥测。

注意

只有当企业团队在当天结束时拥有五个或更多拥有活跃 Copilot 许可证的成员时，此端点才会返回给定日期的结果。

包含企业团队的企业的拥有者和计费管理员可以查看企业团队的 Copilot 使用指标。

OAuth 应用令牌和个人访问令牌（经典版）需要 `manage_billing:copilot` 或 `read:enterprise` 范围才能使用此端点。

“获取企业团队 Copilot 使用情况摘要”的细粒度访问令牌

此端点不适用于 GitHub 应用用户访问令牌、GitHub 应用安装访问令牌或细粒度个人访问令牌。

“获取企业团队 Copilot 使用情况摘要”的参数

标头
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
enterprise 字符串 必需

企业的名称的slug版本。您也可以用企业ID替换此值。

team_slug 字符串 必需

团队名称的slug。

查询参数
since 字符串

显示自此日期以来的使用指标。这是一个 ISO 8601 格式 (YYYY-MM-DDTHH:MM:SSZ) 的时间戳。最大值为 28 天前。

until 字符串

显示直到此日期的使用指标。这是一个 ISO 8601 格式 (YYYY-MM-DDTHH:MM:SSZ) 的时间戳，如果传递了 `since` 日期，则不应早于 `since` 日期。

page 整数

要获取的结果的页码。更多信息，请参阅“在 REST API 中使用分页”。

默认： 1

per_page 整数

每页显示的指标天数（最大 28 天）。更多信息，请参阅“在 REST API 中使用分页”。

默认： 28

“获取企业团队 Copilot 使用情况摘要”的 HTTP 响应状态代码

状态代码描述
200

OK

401

需要身份验证

403

禁止

404

资源未找到

500

内部错误

“获取企业团队 Copilot 使用情况摘要”的代码示例

请求示例

get/enterprises/{enterprise}/team/{team_slug}/copilot/usage
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/team/TEAM_SLUG/copilot/usage

响应

状态：200
[ { "day": "2023-10-15", "total_suggestions_count": 1000, "total_acceptances_count": 800, "total_lines_suggested": 1800, "total_lines_accepted": 1200, "total_active_users": 10, "total_chat_acceptances": 32, "total_chat_turns": 200, "total_active_chat_users": 4, "breakdown": [ { "language": "python", "editor": "vscode", "suggestions_count": 300, "acceptances_count": 250, "lines_suggested": 900, "lines_accepted": 700, "active_users": 5 }, { "language": "python", "editor": "jetbrains", "suggestions_count": 300, "acceptances_count": 200, "lines_suggested": 400, "lines_accepted": 300, "active_users": 2 }, { "language": "ruby", "editor": "vscode", "suggestions_count": 400, "acceptances_count": 350, "lines_suggested": 500, "lines_accepted": 200, "active_users": 3 } ] }, { "day": "2023-10-16", "total_suggestions_count": 800, "total_acceptances_count": 600, "total_lines_suggested": 1100, "total_lines_accepted": 700, "total_active_users": 12, "total_chat_acceptances": 57, "total_chat_turns": 426, "total_active_chat_users": 8, "breakdown": [ { "language": "python", "editor": "vscode", "suggestions_count": 300, "acceptances_count": 200, "lines_suggested": 600, "lines_accepted": 300, "active_users": 2 }, { "language": "python", "editor": "jetbrains", "suggestions_count": 300, "acceptances_count": 150, "lines_suggested": 300, "lines_accepted": 250, "active_users": 6 }, { "language": "ruby", "editor": "vscode", "suggestions_count": 200, "acceptances_count": 150, "lines_suggested": 200, "lines_accepted": 150, "active_users": 3 } ] } ]

获取组织成员 Copilot 使用情况摘要

注意

此端点处于公开预览阶段，可能会发生更改。

您可以使用此端点查看整个组织的 Copilot 代码补全和 Copilot Chat 在 IDE 中的聚合使用指标的每日细分，并进一步按编辑器和语言细分每日建议、接受和活跃用户数量。有关详细的指标定义，请参阅响应模式选项卡。

响应包含最多 28 天前的指标。使用指标每天处理一次前一天的数据，响应中只包含昨天的数据。为了将最终用户计入这些指标，他们必须在其 IDE 中启用遥测。

组织所有者以及父企业的拥有者和计费管理员可以查看 Copilot 使用指标。

OAuth 应用令牌和个人访问令牌（经典版）需要 `manage_billing:copilot`、`read:org` 或 `read:enterprise` 范围才能使用此端点。

“获取组织成员 Copilot 使用情况摘要”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须至少具有以下权限集之一

  • “GitHub Copilot Business”组织权限（读取）
  • “管理”组织权限（读取）

“获取组织成员 Copilot 使用情况摘要”的参数

标头
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
org 字符串 必需

组织名称。名称不区分大小写。

查询参数
since 字符串

显示自此日期以来的使用指标。这是一个 ISO 8601 格式 (YYYY-MM-DDTHH:MM:SSZ) 的时间戳。最大值为 28 天前。

until 字符串

显示直到此日期的使用指标。这是一个 ISO 8601 格式 (YYYY-MM-DDTHH:MM:SSZ) 的时间戳，如果传递了 `since` 日期，则不应早于 `since` 日期。

page 整数

要获取的结果的页码。更多信息，请参阅“在 REST API 中使用分页”。

默认： 1

per_page 整数

每页显示的指标天数（最大 28 天）。更多信息，请参阅“在 REST API 中使用分页”。

默认： 28

“获取组织成员 Copilot 使用情况摘要”的 HTTP 响应状态代码

状态代码描述
200

OK

401

需要身份验证

403

禁止

404

资源未找到

500

内部错误

“获取组织成员 Copilot 使用情况摘要”的代码示例

请求示例

get/orgs/{org}/copilot/usage
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/copilot/usage

响应

状态：200
[ { "day": "2023-10-15", "total_suggestions_count": 1000, "total_acceptances_count": 800, "total_lines_suggested": 1800, "total_lines_accepted": 1200, "total_active_users": 10, "total_chat_acceptances": 32, "total_chat_turns": 200, "total_active_chat_users": 4, "breakdown": [ { "language": "python", "editor": "vscode", "suggestions_count": 300, "acceptances_count": 250, "lines_suggested": 900, "lines_accepted": 700, "active_users": 5 }, { "language": "python", "editor": "jetbrains", "suggestions_count": 300, "acceptances_count": 200, "lines_suggested": 400, "lines_accepted": 300, "active_users": 2 }, { "language": "ruby", "editor": "vscode", "suggestions_count": 400, "acceptances_count": 350, "lines_suggested": 500, "lines_accepted": 200, "active_users": 3 } ] }, { "day": "2023-10-16", "total_suggestions_count": 800, "total_acceptances_count": 600, "total_lines_suggested": 1100, "total_lines_accepted": 700, "total_active_users": 12, "total_chat_acceptances": 57, "total_chat_turns": 426, "total_active_chat_users": 8, "breakdown": [ { "language": "python", "editor": "vscode", "suggestions_count": 300, "acceptances_count": 200, "lines_suggested": 600, "lines_accepted": 300, "active_users": 2 }, { "language": "python", "editor": "jetbrains", "suggestions_count": 300, "acceptances_count": 150, "lines_suggested": 300, "lines_accepted": 250, "active_users": 6 }, { "language": "ruby", "editor": "vscode", "suggestions_count": 200, "acceptances_count": 150, "lines_suggested": 200, "lines_accepted": 150, "active_users": 3 } ] } ]

获取团队 Copilot 使用情况摘要

注意

此端点处于公开预览阶段，可能会发生更改。

您可以使用此端点查看团队内用户在 IDE 中使用 Copilot 代码补全和 Copilot Chat 的每日汇总使用情况细分，其中包含按编辑器和编程语言划分的每日建议、采纳次数和活跃用户数量的进一步细分。有关详细的指标定义，请参阅响应模式选项卡。

响应包含最多 28 天前的指标。使用指标每天处理一次前一天的数据，响应中只包含昨天的数据。为了将最终用户计入这些指标，他们必须在其 IDE 中启用遥测。

注意

只有在该团队在当天结束时拥有五名或五名以上具有活跃 Copilot 许可证的成员时，此端点才会返回该天的结果。

包含此团队的组织的组织所有者，以及父企业的拥有者和账单管理员可以查看团队的 Copilot 使用情况指标。

OAuth 应用令牌和个人访问令牌（经典版）需要 `manage_billing:copilot`、`read:org` 或 `read:enterprise` 范围才能使用此端点。

“获取团队 Copilot 使用情况摘要”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须至少具有以下权限集之一

  • “GitHub Copilot Business”组织权限（读取）
  • “管理”组织权限（读取）

“获取团队 Copilot 使用情况摘要”的参数

标头
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
org 字符串 必需

组织名称。名称不区分大小写。

team_slug 字符串 必需

团队名称的slug。

查询参数
since 字符串

显示自此日期以来的使用指标。这是一个 ISO 8601 格式 (YYYY-MM-DDTHH:MM:SSZ) 的时间戳。最大值为 28 天前。

until 字符串

显示直到此日期的使用指标。这是一个 ISO 8601 格式 (YYYY-MM-DDTHH:MM:SSZ) 的时间戳，如果传递了 `since` 日期，则不应早于 `since` 日期。

page 整数

要获取的结果的页码。更多信息，请参阅“在 REST API 中使用分页”。

默认： 1

per_page 整数

每页显示的指标天数（最大 28 天）。更多信息，请参阅“在 REST API 中使用分页”。

默认： 28

“获取团队 Copilot 使用情况摘要”的 HTTP 响应状态码

状态代码描述
200

OK

401

需要身份验证

403

禁止

404

资源未找到

500

内部错误

“获取团队 Copilot 使用情况摘要”的代码示例

请求示例

get/orgs/{org}/team/{team_slug}/copilot/usage
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/team/TEAM_SLUG/copilot/usage

响应

状态：200
[ { "day": "2023-10-15", "total_suggestions_count": 1000, "total_acceptances_count": 800, "total_lines_suggested": 1800, "total_lines_accepted": 1200, "total_active_users": 10, "total_chat_acceptances": 32, "total_chat_turns": 200, "total_active_chat_users": 4, "breakdown": [ { "language": "python", "editor": "vscode", "suggestions_count": 300, "acceptances_count": 250, "lines_suggested": 900, "lines_accepted": 700, "active_users": 5 }, { "language": "python", "editor": "jetbrains", "suggestions_count": 300, "acceptances_count": 200, "lines_suggested": 400, "lines_accepted": 300, "active_users": 2 }, { "language": "ruby", "editor": "vscode", "suggestions_count": 400, "acceptances_count": 350, "lines_suggested": 500, "lines_accepted": 200, "active_users": 3 } ] }, { "day": "2023-10-16", "total_suggestions_count": 800, "total_acceptances_count": 600, "total_lines_suggested": 1100, "total_lines_accepted": 700, "total_active_users": 12, "total_chat_acceptances": 57, "total_chat_turns": 426, "total_active_chat_users": 8, "breakdown": [ { "language": "python", "editor": "vscode", "suggestions_count": 300, "acceptances_count": 200, "lines_suggested": 600, "lines_accepted": 300, "active_users": 2 }, { "language": "python", "editor": "jetbrains", "suggestions_count": 300, "acceptances_count": 150, "lines_suggested": 300, "lines_accepted": 250, "active_users": 6 }, { "language": "ruby", "editor": "vscode", "suggestions_count": 200, "acceptances_count": 150, "lines_suggested": 200, "lines_accepted": 150, "active_users": 3 } ] } ]