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

Copilot 指标的 REST API 端点

使用 REST API 查看 Copilot 指标。

获取企业的 Copilot 指标

使用此端点查看各种 GitHub Copilot 功能的聚合指标细分。有关详细的指标定义，请参阅响应模式选项卡。

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

要访问此端点，必须在 GitHub 设置中为企业启用 Copilot 指标 API 访问策略或将其设置为“无策略”。只有企业所有者和账单管理员才能查看企业的 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

403

禁止

404

资源未找到

422

在组织或企业级别禁用了 Copilot 使用指标 API 设置。

500

内部错误

“获取企业的 Copilot 指标”的代码示例

请求示例

get/enterprises/{enterprise}/copilot/metrics
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/metrics

响应

状态：200
[ { "date": "2024-06-24", "total_active_users": 24, "total_engaged_users": 20, "copilot_ide_code_completions": { "total_engaged_users": 20, "languages": [ { "name": "python", "total_engaged_users": 10 }, { "name": "ruby", "total_engaged_users": 10 } ], "editors": [ { "name": "vscode", "total_engaged_users": 13, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_engaged_users": 13, "languages": [ { "name": "python", "total_engaged_users": 6, "total_code_suggestions": 249, "total_code_acceptances": 123, "total_code_lines_suggested": 225, "total_code_lines_accepted": 135 }, { "name": "ruby", "total_engaged_users": 7, "total_code_suggestions": 496, "total_code_acceptances": 253, "total_code_lines_suggested": 520, "total_code_lines_accepted": 270 } ] } ] }, { "name": "neovim", "total_engaged_users": 7, "models": [ { "name": "a-custom-model", "is_custom_model": true, "custom_model_training_date": "2024-02-01", "languages": [ { "name": "typescript", "total_engaged_users": 3, "total_code_suggestions": 112, "total_code_acceptances": 56, "total_code_lines_suggested": 143, "total_code_lines_accepted": 61 }, { "name": "go", "total_engaged_users": 4, "total_code_suggestions": 132, "total_code_acceptances": 67, "total_code_lines_suggested": 154, "total_code_lines_accepted": 72 } ] } ] } ] }, "copilot_ide_chat": { "total_engaged_users": 13, "editors": [ { "name": "vscode", "total_engaged_users": 13, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_engaged_users": 12, "total_chats": 45, "total_chat_insertion_events": 12, "total_chat_copy_events": 16 }, { "name": "a-custom-model", "is_custom_model": true, "custom_model_training_date": "2024-02-01", "total_engaged_users": 1, "total_chats": 10, "total_chat_insertion_events": 11, "total_chat_copy_events": 3 } ] } ] }, "copilot_dotcom_chat": { "total_engaged_users": 14, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_engaged_users": 14, "total_chats": 38 } ] }, "copilot_dotcom_pull_requests": { "total_engaged_users": 12, "repositories": [ { "name": "demo/repo1", "total_engaged_users": 8, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_pr_summaries_created": 6, "total_engaged_users": 8 } ] }, { "name": "demo/repo2", "total_engaged_users": 4, "models": [ { "name": "a-custom_model", "is_custom_model": true, "custom_model_training_date": "2024-02-01", "total_pr_summaries_created": 10, "total_engaged_users": 4 } ] } ] } } ]

获取企业团队的 Copilot 指标

使用此端点查看各种 GitHub Copilot 功能的聚合指标细分。有关详细的指标定义，请参阅响应模式选项卡。

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

注意

只有当企业团队在当天拥有**五名或五名以上拥有活动 Copilot 许可证的成员**（在当天结束时评估）时，此端点才会返回给定日期的结果。

要访问此端点，必须在 GitHub 设置中为企业启用 Copilot 指标 API 访问策略或将其设置为“无策略”。只有包含企业团队的企业的拥有者和账单管理员才能查看企业团队的 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

403

禁止

404

资源未找到

422

在组织或企业级别禁用了 Copilot 使用指标 API 设置。

500

内部错误

“获取企业团队的 Copilot 指标”的代码示例

请求示例

get/enterprises/{enterprise}/team/{team_slug}/copilot/metrics
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/metrics

响应

状态：200
[ { "date": "2024-06-24", "total_active_users": 24, "total_engaged_users": 20, "copilot_ide_code_completions": { "total_engaged_users": 20, "languages": [ { "name": "python", "total_engaged_users": 10 }, { "name": "ruby", "total_engaged_users": 10 } ], "editors": [ { "name": "vscode", "total_engaged_users": 13, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_engaged_users": 13, "languages": [ { "name": "python", "total_engaged_users": 6, "total_code_suggestions": 249, "total_code_acceptances": 123, "total_code_lines_suggested": 225, "total_code_lines_accepted": 135 }, { "name": "ruby", "total_engaged_users": 7, "total_code_suggestions": 496, "total_code_acceptances": 253, "total_code_lines_suggested": 520, "total_code_lines_accepted": 270 } ] } ] }, { "name": "neovim", "total_engaged_users": 7, "models": [ { "name": "a-custom-model", "is_custom_model": true, "custom_model_training_date": "2024-02-01", "languages": [ { "name": "typescript", "total_engaged_users": 3, "total_code_suggestions": 112, "total_code_acceptances": 56, "total_code_lines_suggested": 143, "total_code_lines_accepted": 61 }, { "name": "go", "total_engaged_users": 4, "total_code_suggestions": 132, "total_code_acceptances": 67, "total_code_lines_suggested": 154, "total_code_lines_accepted": 72 } ] } ] } ] }, "copilot_ide_chat": { "total_engaged_users": 13, "editors": [ { "name": "vscode", "total_engaged_users": 13, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_engaged_users": 12, "total_chats": 45, "total_chat_insertion_events": 12, "total_chat_copy_events": 16 }, { "name": "a-custom-model", "is_custom_model": true, "custom_model_training_date": "2024-02-01", "total_engaged_users": 1, "total_chats": 10, "total_chat_insertion_events": 11, "total_chat_copy_events": 3 } ] } ] }, "copilot_dotcom_chat": { "total_engaged_users": 14, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_engaged_users": 14, "total_chats": 38 } ] }, "copilot_dotcom_pull_requests": { "total_engaged_users": 12, "repositories": [ { "name": "demo/repo1", "total_engaged_users": 8, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_pr_summaries_created": 6, "total_engaged_users": 8 } ] }, { "name": "demo/repo2", "total_engaged_users": 4, "models": [ { "name": "a-custom_model", "is_custom_model": true, "custom_model_training_date": "2024-02-01", "total_pr_summaries_created": 10, "total_engaged_users": 4 } ] } ] } } ]

获取组织的 Copilot 指标

使用此端点查看各种 GitHub Copilot 功能的聚合指标细分。有关详细的指标定义，请参阅响应模式选项卡。

注意

只有当组织在当天拥有**五名或五名以上拥有活动 Copilot 许可证的成员**（在当天结束时评估）时，此端点才会返回给定日期的结果。

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

要访问此端点，必须为组织启用 Copilot 指标 API 访问策略。只有组织所有者以及父企业的所有者和账单管理员才能查看 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

403

禁止

404

资源未找到

422

在组织或企业级别禁用了 Copilot 使用指标 API 设置。

500

内部错误

“获取组织的 Copilot 指标”的代码示例

请求示例

get/orgs/{org}/copilot/metrics
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/metrics

响应

状态：200
[ { "date": "2024-06-24", "total_active_users": 24, "total_engaged_users": 20, "copilot_ide_code_completions": { "total_engaged_users": 20, "languages": [ { "name": "python", "total_engaged_users": 10 }, { "name": "ruby", "total_engaged_users": 10 } ], "editors": [ { "name": "vscode", "total_engaged_users": 13, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_engaged_users": 13, "languages": [ { "name": "python", "total_engaged_users": 6, "total_code_suggestions": 249, "total_code_acceptances": 123, "total_code_lines_suggested": 225, "total_code_lines_accepted": 135 }, { "name": "ruby", "total_engaged_users": 7, "total_code_suggestions": 496, "total_code_acceptances": 253, "total_code_lines_suggested": 520, "total_code_lines_accepted": 270 } ] } ] }, { "name": "neovim", "total_engaged_users": 7, "models": [ { "name": "a-custom-model", "is_custom_model": true, "custom_model_training_date": "2024-02-01", "languages": [ { "name": "typescript", "total_engaged_users": 3, "total_code_suggestions": 112, "total_code_acceptances": 56, "total_code_lines_suggested": 143, "total_code_lines_accepted": 61 }, { "name": "go", "total_engaged_users": 4, "total_code_suggestions": 132, "total_code_acceptances": 67, "total_code_lines_suggested": 154, "total_code_lines_accepted": 72 } ] } ] } ] }, "copilot_ide_chat": { "total_engaged_users": 13, "editors": [ { "name": "vscode", "total_engaged_users": 13, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_engaged_users": 12, "total_chats": 45, "total_chat_insertion_events": 12, "total_chat_copy_events": 16 }, { "name": "a-custom-model", "is_custom_model": true, "custom_model_training_date": "2024-02-01", "total_engaged_users": 1, "total_chats": 10, "total_chat_insertion_events": 11, "total_chat_copy_events": 3 } ] } ] }, "copilot_dotcom_chat": { "total_engaged_users": 14, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_engaged_users": 14, "total_chats": 38 } ] }, "copilot_dotcom_pull_requests": { "total_engaged_users": 12, "repositories": [ { "name": "demo/repo1", "total_engaged_users": 8, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_pr_summaries_created": 6, "total_engaged_users": 8 } ] }, { "name": "demo/repo2", "total_engaged_users": 4, "models": [ { "name": "a-custom_model", "is_custom_model": true, "custom_model_training_date": "2024-02-01", "total_pr_summaries_created": 10, "total_engaged_users": 4 } ] } ] } } ]

获取团队的 Copilot 指标

使用此端点查看各种 GitHub Copilot 功能的聚合指标细分。有关详细的指标定义，请参阅响应模式选项卡。

注意

只有当团队在当天 **有五个或更多拥有活动 Copilot 许可证的成员**（以当天结束时为准）时，此端点才会返回给定日期的结果。

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

要访问此端点，必须在 GitHub 设置中为包含团队的组织启用 Copilot 指标 API 访问策略。只有包含此团队的组织的所有者以及父企业的所有者和账单管理员才能查看团队的 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

403

禁止

404

资源未找到

422

在组织或企业级别禁用了 Copilot 使用指标 API 设置。

500

内部错误

“获取团队的 Copilot 指标”的代码示例

请求示例

get/orgs/{org}/team/{team_slug}/copilot/metrics
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/metrics

响应

状态：200
[ { "date": "2024-06-24", "total_active_users": 24, "total_engaged_users": 20, "copilot_ide_code_completions": { "total_engaged_users": 20, "languages": [ { "name": "python", "total_engaged_users": 10 }, { "name": "ruby", "total_engaged_users": 10 } ], "editors": [ { "name": "vscode", "total_engaged_users": 13, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_engaged_users": 13, "languages": [ { "name": "python", "total_engaged_users": 6, "total_code_suggestions": 249, "total_code_acceptances": 123, "total_code_lines_suggested": 225, "total_code_lines_accepted": 135 }, { "name": "ruby", "total_engaged_users": 7, "total_code_suggestions": 496, "total_code_acceptances": 253, "total_code_lines_suggested": 520, "total_code_lines_accepted": 270 } ] } ] }, { "name": "neovim", "total_engaged_users": 7, "models": [ { "name": "a-custom-model", "is_custom_model": true, "custom_model_training_date": "2024-02-01", "languages": [ { "name": "typescript", "total_engaged_users": 3, "total_code_suggestions": 112, "total_code_acceptances": 56, "total_code_lines_suggested": 143, "total_code_lines_accepted": 61 }, { "name": "go", "total_engaged_users": 4, "total_code_suggestions": 132, "total_code_acceptances": 67, "total_code_lines_suggested": 154, "total_code_lines_accepted": 72 } ] } ] } ] }, "copilot_ide_chat": { "total_engaged_users": 13, "editors": [ { "name": "vscode", "total_engaged_users": 13, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_engaged_users": 12, "total_chats": 45, "total_chat_insertion_events": 12, "total_chat_copy_events": 16 }, { "name": "a-custom-model", "is_custom_model": true, "custom_model_training_date": "2024-02-01", "total_engaged_users": 1, "total_chats": 10, "total_chat_insertion_events": 11, "total_chat_copy_events": 3 } ] } ] }, "copilot_dotcom_chat": { "total_engaged_users": 14, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_engaged_users": 14, "total_chats": 38 } ] }, "copilot_dotcom_pull_requests": { "total_engaged_users": 12, "repositories": [ { "name": "demo/repo1", "total_engaged_users": 8, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_pr_summaries_created": 6, "total_engaged_users": 8 } ] }, { "name": "demo/repo2", "total_engaged_users": 4, "models": [ { "name": "a-custom_model", "is_custom_model": true, "custom_model_training_date": "2024-02-01", "total_pr_summaries_created": 10, "total_engaged_users": 4 } ] } ] } } ]