使用情况报告显示有关帐户 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 月 1 日 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 托管 runner 和自托管 runner 的 GitHub Actions 使用折扣 |
net_amount | 应用 discount_amount 后的可计费使用量。 这是你的帐户将被计费的金额。 gross_amount - discount_amount = net_amount |
username | 与使用情况关联的用户(如适用)。 不包括在 Summarized usage report内。 |
organization | 与使用情况关联的组织(如适用)。 |
repository | 与使用情况关联的仓库(如适用)。 |
workflow_path | 生成此使用情况的 GitHub Actions 工作流路径(如适用)。 仅在 Detailed usage report 中可用 |
cost_center_name | 与使用情况关联的成本中心(如适用)。 |
model | 所使用的模型。 这可能是 LLM(如 claude-sonnet-4)或特定于产品的模型(如 Code Review model)。 仅在 Premium request usage report 中可用 |
exceeds_quota | 指示高级请求是否超过用户的每月配额: |
-
`FALSE`:请求由用户计划中包含的每月配额涵盖。<br>
-
`TRUE`:请求超出每月配额,并进行相应计费 <br><br>仅在 `Premium request usage report` 中可用 |
| total_monthly_quota | 用户当前计划中包含的请求数。
仅在 Premium request usage report 中可用 |
接收报告
使用情况报告会通过电子邮件发送至与你的 GitHub 帐户关联的默认电子邮件地址。 每个帐户一次只能请求一份使用情况报告。
计量使用报告中已关闭的字段
GitHub 旨在最大程度地减少对使用情况报告结构的更改,但有时报告结构或字段可能会发生变化。
已从使用情况报表中删除以下字段。
| 字段 | 替代 |
|---|---|
usage_at | 请改为参考 date。 |
workflow_name | 请改为参考 workflow_path。 |