Skip to content

Commit a43b16c

Browse files
felicitymaylecoursenamrithss
authored
[2025-09-29] Docs updates for the GA of the Copilot Premium requests analytics page (#57704)
Co-authored-by: Laura Coursen <[email protected]> Co-authored-by: amrithss <[email protected]>
1 parent 0333420 commit a43b16c

16 files changed

+220
-135
lines changed
41.1 KB
Loading
187 KB
Loading
79.1 KB
Loading
156 KB
Loading
98.9 KB
Loading

content/billing/how-tos/products/view-productlicense-use.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ The options available to you vary according to your role and {% data variables.p
7676

7777
## Exploring usage data in more detail
7878

79-
You can also explore usage data in more detail in the **{% octicon "graph" aria-label="chart" aria-hidden="true" %} Usage** view.
79+
You can also explore usage data for all metered products in more detail in the **Usage** or **Metered usage** view.
8080

8181
* **Filter data on the page**: click in the text box to see a list of available filters.
8282
* **Group data**: options in the "Group" option vary based on the filters you define.
@@ -91,22 +91,45 @@ The metered usage chart and usage break down table both show your current choice
9191
> For GitHub Actions, you can also view the billable job execution minutes for an individual workflow run. For more information, see [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-job-execution-time).
9292
{% endif %}
9393

94+
## Analyzing use of premium requests
95+
96+
{% data reusables.billing.premium-request-analytics-start %}
97+
98+
If you use premium requests, an additional **Premium request analytics** view is listed under **Usage**. You can use this view to dig deeper into how you are using included requests and where you are being billed for additional requests. For example:
99+
100+
* What's our total usage of premiums requests across all products?
101+
* Are users making good use of the premium requests included in their license for {% data variables.product.prodname_copilot_short %}?
102+
* Which users have consumed more than their monthly quota?
103+
* How widespread is adoption in the organizations where we rolled out {% data variables.product.prodname_copilot_short %}?
104+
105+
As you change the filter, "Timeframe", and "Group by", and options, all areas of the page are updated to reflect your choices. The chart shows the top 5 consumers and combines any other consumers into "All other".
106+
107+
![Screenshot of the premium request analytics chart, "Usage grouped by organization", and table. A "Show Usage Breakdown" arrow is outlined.](/assets/images/help/billing/premium-request-analytics-chart.png)
108+
109+
To show more detailed information for the top 100 users or organizations consuming premium requests, use the {% octicon "chevron-right" aria-label="Show Usage Breakdown" aria-hidden="true" %} shown at the start of each row to expand and collapse data.
110+
111+
![Screenshot of the premium request analytics table, "Usage breakdown" with the first row expanded to show a full breakdown of requests.](/assets/images/help/billing/premium-request-analytics-org-table.png)
112+
94113
## Downloading usage reports
95114

96-
You can download two different types of usage report from the "Usage" page.
115+
Visit the "Metered Usage" page to access a metered billing report for all products, or navigate to the "Premium request analytics" page for a specialized report tailored for Premium request activity tracking.
97116

98117
### General usage reports
99118

100-
1. At the top of the "Usage" page, click **Get usage report**.
101-
1. Choose the report that you want to download.
119+
1. At the top of the page, click **Get usage report**.
120+
1. If prompted, specify the report details:
121+
* Metered usage page: in the dialog displayed, define details of the report that you want to download and click **Email me the report**.
122+
* Premium request analytics page: the report will contain usage for the last 45 days.
123+
124+
When the report is ready for you to download, you'll receive a message to your primary email account with a link to download the report. The link will expire after 24 hours.
102125

103-
For details of the fields included in the report, see [AUTOTITLE](/billing/reference/usage-reports).
126+
For details of the fields included in the reports, see [AUTOTITLE](/billing/reference/billing-reports).
104127

105-
### Downloading the data plotted in the usage chart
128+
### Downloading the data plotted in the chart
106129

107-
When the chart on the "Usage" page shows the data you want to download, click the {% octicon "kebab-horizontal" aria-label="Chart options" aria-hidden="true" %} "Chart options" button and select your preferred format.
130+
When the chart on the "Usage" or "Premium request analytics" page shows the data you want to download, click the {% octicon "kebab-horizontal" aria-label="Chart options" aria-hidden="true" %} "Chart options" button and select your preferred format.
108131

109-
![Screenshot of the metered usage chart on the "Usage" page with the "Chart options" outlined in dark orange.](/assets/images/help/billing/overview-chart-download-button.png)
132+
![Screenshot of the usage chart on the "Premium request analytics" page with "Chart options" open and outlined in dark orange.](/assets/images/help/billing/premium-request-analytics-chart-download.png)
110133

111134
## Next steps
112135

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
title: Billing reports reference
3+
shortTitle: Billing reports
4+
intro: 'Billing reports show detailed {% data variables.product.github %} usage, premium request usage, and billing information for your account.'
5+
versions:
6+
fpt: '*'
7+
ghec: '*'
8+
ghes: '*'
9+
topics:
10+
- Billing
11+
- Enterprise
12+
- Team
13+
permissions: '{% data reusables.permissions.enhanced-billing-enterprise %}'
14+
redirect_from:
15+
- /billing/managing-your-billing/about-usage-reports
16+
- /billing/reference/usage-reports
17+
contentType: reference
18+
---
19+
20+
The usage reports show detailed information about your account’s {% data variables.product.github %} usage, including how much of each SKU was used and the resulting billable amount.
21+
22+
To generate a usage report, see [AUTOTITLE](/billing/how-tos/products/view-productlicense-use).
23+
24+
## Report types
25+
26+
There are three different types of reports.
27+
28+
* Metered usage page:
29+
* **Summarized metered usage reports**: A summary of usage for all paid products for a maximum period of one year.
30+
* **Detailed metered usage reports**: A detailed usage report for all paid products for a maximum period of 31 days.
31+
* Premium request analytics page:
32+
* **Premium request analytics usage reports**: A detailed, user-based report on usage of premium requests for the last 45 days.
33+
34+
### Summarized metered usage reports
35+
36+
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.
37+
38+
### Detailed metered usage reports
39+
40+
The detailed usage report includes the same fields as the summarized report and adds `username` and `workflow_path`.
41+
42+
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`.
43+
44+
### Premium request analytics usage reports
45+
46+
This report includes each recorded use of a premium request and includes the following fields: `Timestamp`,`User`,`Model`,`Requests Used`,`Exceeds Monthly Quota`, and `Total Monthly Quota`.
47+
48+
## Metered usage report fields
49+
50+
The usage report contains the following fields.
51+
52+
| Field | Description |
53+
|---------------------------|-------------|
54+
| `date` | The day that the usage occurred. All usage is logged in UTC. |
55+
| `product` | The {% data variables.product.github %} product that was used. |
56+
| `sku` | The specific {% data variables.product.github %} product SKU that was used. |
57+
| `quantity` | The amount of the SKU that was used. |
58+
| `unit_type` | The unit of measurement for the product SKU. |
59+
| `applied_cost_per_quantity` | The unit cost of the product SKU. |
60+
| `gross_amount` | The amount of the product SKU that was used. |
61+
| `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 {% data variables.product.prodname_actions %} usage for standard {% data variables.product.github %}-hosted runners in public repositories and for self-hosted runners. |
62+
| `net_amount` | The billable amount of usage after applying the `discount_amount`. This is the amount that your account will be billed. `gross_amount - discount_amount = net_amount`. |
63+
| `username` | The user associated with the usage, if applicable. Only available in the detailed report. |
64+
| `organization` | The organization associated with the usage, if applicable. |
65+
| `repository` | The repository associated with the usage, if applicable. |
66+
| `workflow_path` | The path of the {% data variables.product.prodname_actions %} workflow that generated the usage, if applicable. Only available in the detailed report. |
67+
| `cost_center_name` | The cost center associated with the usage, if applicable. |
68+
69+
### Metered usage report fields that are closing down
70+
71+
{% data variables.product.github %} aims to minimize changes to the usage report structure, however at times the report structure or fields may change.
72+
73+
| Closing down | Replacement |
74+
|--------------------|---------------------|
75+
| `usage_at` | Refer to `date` instead. |
76+
| `workflow_name` | Refer to `workflow_path` instead. |
77+
78+
## Premium request analytics usage report fields
79+
80+
{% data reusables.billing.premium-request-analytics-start %}
81+
82+
The premium request analytics report contains the following fields.
83+
84+
| Field | Description |
85+
|---------------------------|-------------|
86+
| Timestamp | The full UTC date and time in ISO 18601 format. |
87+
| User | The {% data variables.product.github %} handle of the user associated with the usage. |
88+
| Model | The model used. This might be an LLM like `claude-sonnet-4`, or a product-specific model like `Code Review model`.
89+
| Requests Used | The total number of requests used. |
90+
| Exceeds Monthly Quota | This field indicates whether the premium request will be billed separately:<br>- `FALSE`: The request is covered by the monthly quota included in the user's plan.<br>- `TRUE`: The request exceeds the monthly quota and will be billed |
91+
| Total Monthly Quota | This field records the total number of requests included in the user's current plan{% ifversion fpt or ghec %}, see [AUTOTITLE](/copilot/concepts/billing/individual-plans) and [AUTOTITLE](/copilot/concepts/billing/organizations-and-enterprises){% endif %}. |
92+
93+
## Receiving the report
94+
95+
Usage reports are sent via email to the default email address associated with your {% data variables.product.github %} account. You can only request one usage report per account at a time.

content/billing/reference/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ topics:
1111
children:
1212
- /product-usage-included
1313
- /actions-minute-multipliers
14-
- /usage-reports
14+
- /billing-reports
1515
- /supported-payment-methods
1616
- /azure-subscription
1717
- /billing-roles
@@ -23,4 +23,3 @@ children:
2323
- /enterprise-license-troubleshooting
2424
contentType: reference
2525
---
26-

content/billing/reference/usage-reports.md

Lines changed: 0 additions & 72 deletions
This file was deleted.

0 commit comments

Comments
 (0)