GitHub Copilot 使用指标的 REST API 端点
使用 REST API 访问企业、组织或团队的 Copilot 使用指标。
获取企业成员 Copilot 使用情况的摘要
注意：此端点处于测试阶段，可能会发生变化。
您可以使用此端点查看企业中所有具有 Copilot 访问权限的组织的 Copilot 完成和 Copilot Chat 在 IDE 中的汇总使用指标的每日细分，并进一步细分每个日期的建议、接受和活动用户数量（按编辑器和语言分类）。有关详细的指标定义，请参见响应模式选项卡。
响应包含过去 28 天的指标。使用指标每天处理一次，用于前一天，响应将仅包含截至昨天的数据。为了让最终用户计入这些指标，他们必须在其 IDE 中启用遥测。
只有所有者和计费管理员可以查看企业的 Copilot 使用指标。
OAuth 应用程序令牌和个人访问令牌（经典）需要 manage_billing:copilot 或 read:enterprise 范围才能使用此端点。
针对“获取企业成员 Copilot 使用情况摘要”的细粒度访问令牌
此端点不适用于 GitHub App 用户访问令牌、GitHub App 安装访问令牌或细粒度个人访问令牌。
“获取企业成员 Copilot 使用情况摘要”的参数
| 名称、类型、描述 |
|---|
accept string 建议设置为 |
| 名称、类型、描述 |
|---|
enterprise string 必需企业名称的 slug 版本。您也可以用企业 ID 替换此值。 |
| 名称、类型、描述 |
|---|
since string 显示自此日期以来的使用指标。这是一个 ISO 8601 格式（ |
until string 显示直到此日期的使用指标。这是一个 ISO 8601 格式（ |
page integer 要获取的结果的页码。有关更多信息，请参阅“在 REST API 中使用分页”。 默认: |
per_page integer 每页显示的指标天数（最大 28 天）。有关更多信息，请参阅“在 REST API 中使用分页”。 默认: |
“获取企业成员 Copilot 使用情况摘要”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
200 | OK |
401 | 需要身份验证 |
403 | 禁止 |
404 | 资源未找到 |
500 | 内部错误 |
“获取企业成员 Copilot 使用情况摘要”的代码示例
请求示例
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 使用指标。
OAuth 应用程序令牌和个人访问令牌（经典）需要 manage_billing:copilot、read:org 或 read:enterprise 范围才能使用此端点。
用于“获取组织成员 Copilot 使用情况摘要”的细粒度访问令牌
此端点适用于以下细粒度令牌类型
细粒度令牌必须具有以下权限集
- "GitHub Copilot Business" 组织权限（写入） 和 "管理" 组织权限（读取） 和 "企业管理" 业务权限（读取）
“获取组织成员 Copilot 使用情况摘要” 的参数
| 名称、类型、描述 |
|---|
accept string 建议设置为 |
| 名称、类型、描述 |
|---|
org string 必需组织名称。名称不区分大小写。 |
| 名称、类型、描述 |
|---|
since string 显示自此日期以来的使用指标。这是一个 ISO 8601 格式（ |
until string 显示直到此日期的使用指标。这是一个 ISO 8601 格式（ |
page integer 要获取的结果的页码。有关更多信息，请参阅“在 REST API 中使用分页”。 默认: |
per_page integer 每页显示的指标天数（最大 28 天）。有关更多信息，请参阅“在 REST API 中使用分页”。 默认: |
“获取组织成员 Copilot 使用情况摘要” 的 HTTP 响应状态码
| 状态代码 | 描述 |
|---|---|
200 | OK |
401 | 需要身份验证 |
403 | 禁止 |
404 | 资源未找到 |
500 | 内部错误 |
“获取组织成员 Copilot 使用情况摘要” 的代码示例
请求示例
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 } ] } ]