Usage reports show detailed information about your account’s GitHub usage, including how much of each SKU was used and the resulting billable amount.
To generate a usage report, see Viewing your usage of metered products and licenses.
Report types
The following report types are available.
- Metered usage page:
- Summarized usage report: A summary of usage for all paid products for a maximum period of one year.
- Detailed usage report: A detailed usage report for all paid products for a maximum period of 31 days.
Summarized usage report
This report sums the quantity, gross_amount, discount_amount, and net_amount fields based on the combination of the following values: date, sku, repository, cost_center_name. If the usage report is for an enterprise with organizations, the amounts will be summarized by the organization value as well.
Detailed usage report
The detailed usage report includes the same fields as the summarized report and adds username and workflow_path.
This report sums the quantity, gross_amount, discount_amount, and net_amount fields based on the combination of the following values: date, sku, organization, repository, cost_center_name, username, workflow_path.
Note
Data for the detailed usage report is available only through the GitHub web interface and cannot be obtained via the REST API /usage endpoint. The REST API only provides access to summarized billing information.
Usage report fields
The usage reports contain the following fields.
| Field | Description |
|---|---|
date | The day that the usage occurred. All usage is logged in UTC. |
product | The GitHub product that was used. |
sku | The specific GitHub product SKU that was used. |
quantity | The amount of the SKU that was used. |
unit_type | The unit of measurement for the product SKU. |
applied_cost_ | The unit cost of the product SKU. |
gross_amount | The amount of the product SKU that was used. |
discount_amount | The amount of usage that was discounted. Usage that is discounted as part of your account’s included usage is reflected in this field. Also includes discounts for GitHub Actions usage for standard GitHub-hosted runners in public repositories and for self-hosted runners. |