使用报告显示您账户的 GitHub 使用详细信息,包括每个 SKU 的使用量以及相应的计费金额。
要生成使用报告,请参阅 查看计量产品和许可证的使用情况。
报告类型
以下报告类型可供使用。
- 计量使用页面
- 汇总使用报告:所有付费产品在最长一年期间的使用摘要。
- 详细使用报告:所有付费产品在最长 31 天期间的详细使用报告。
- 高级请求分析页面
- 高级请求使用报告:对高级请求的每位用户使用情况进行详细划分,最长 31 天。
汇总使用报告
此报告根据以下值的组合汇总 quantity、gross_amount、discount_amount 和 net_amount 字段:date、sku、repository、cost_center_name。如果使用报告针对拥有组织的企业,则还会按组织值进行汇总。
详细使用报告
详细使用报告包含与汇总报告相同的字段,并额外添加 username 和 workflow_path。
此报告根据以下值的组合汇总 quantity、gross_amount、discount_amount 和 net_amount 字段:date、sku、organization、repository、cost_center_name、username、workflow_path。
注意
详细使用报告的数据仅可通过 GitHub Web 界面获取,无法通过 REST API /usage 端点获得。REST API 仅提供汇总计费信息的访问。
高级请求使用报告
此报告包含有关高级请求使用的额外细节。报告根据以下值的组合汇总 quantity、gross_amount、discount_amount 和 net_amount 字段:date、model、username。
此报告的使用记录始于 2025 年 10 月 01 日 00:00 UTC。
使用报告字段
使用报告包含以下字段。
| 字段 | 描述 |
|---|---|
date | 使用发生的日期。所有使用均记录为 UTC 时间。 |
product | 被使用的 GitHub 产品。 |
sku | 被使用的特定 GitHub 产品 SKU。 |
quantity | 使用的 SKU 数量。 |
unit_type | 产品 SKU 的计量单位。 |
applied_cost_per_quantity | 产品 SKU 的单价。 |
gross_amount | 使用的产品 SKU 的总金额。 |
discount_amount | 被折扣的使用量。计入您账户已包含使用额度的折扣会显示在此字段中。还包括对公共仓库中标准 GitHub‑hosted runner 以及自托管 runner 的 GitHub Actions 使用的折扣。 |
net_amount | 在应用 discount_amount 后的计费使用金额。这是您账户将被计费的金额。gross_amount - discount_amount = net_amount |
username | 与使用关联的用户(如果适用)。 未包含在 汇总使用报告 中。 |
organization | 与使用关联的组织(如果适用)。 |
repository | 与使用关联的仓库(如果适用)。 |
workflow_path | 生成使用的 GitHub Actions 工作流路径(如果适用)。 仅在 详细使用报告 中可用 |
cost_center_name | 与使用关联的成本中心(如果适用)。 |
model | 使用的模型。可能是像 claude-sonnet-4 这样的 LLM,或是特定产品的模型,例如 Code Review model。仅在 高级请求使用报告 中可用 |
exceeds_quota | 指示高级请求是否超过用户的月配额 - FALSE:请求已被用户计划中包含的月配额覆盖。- TRUE:请求超过月配额,将被计费仅在 高级请求使用报告 中可用 |
total_monthly_quota | 用户当前计划中包含的请求数量。参阅 关于个人 GitHub Copilot 计划及福利 和 关于组织和企业的 GitHub Copilot 计费。 仅在 高级请求使用报告 中可用 |
接收报告
使用报告会通过电子邮件发送至与您的 GitHub 账户关联的默认电子邮箱。每次只能为一个账户请求一份使用报告。
已停用的计量使用报告字段
GitHub 力求最小化使用报告结构的变更,但有时报告结构或字段可能会发生变化。
以下字段已从使用报告中移除。
| 字段 | 替代字段 |
|---|---|
usage_at | 请改用 date。 |
workflow_name | 请改用 workflow_path。 |