Skip to content

Commit 4c9684f

Browse files
djopatrnyisaacmbrownlaurenNYC
authored
Update user activity data section for GitHub Copilot... (#56708)
Co-authored-by: isaacmbrown <[email protected]> Co-authored-by: Isaac Brown <[email protected]> Co-authored-by: Lauren <[email protected]>
1 parent 1be70be commit 4c9684f

File tree

7 files changed

+104
-6
lines changed

7 files changed

+104
-6
lines changed
193 KB
Loading
108 KB
Loading
79.3 KB
Loading
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: Downloading a Copilot activity report for your organization or enterprise
3+
intro: 'Monitor Copilot license usage with a detailed report.'
4+
permissions: Enterprise owners and organization owners
5+
product: '{% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %}'
6+
versions:
7+
feature: copilot
8+
allowTitleToDifferFromFilename: true
9+
type: how_to
10+
topics:
11+
- Copilot
12+
- Enterprise
13+
shortTitle: Download activity report
14+
---
15+
16+
You can download a CSV report for {% data variables.product.prodname_copilot_short %} user activity in your organization. The data in the report allows you to:
17+
18+
* Accurately monitor {% data variables.product.prodname_copilot_short %} license usage accurately.
19+
* Understand patterns in user authentication.
20+
* Manage licenses and measure key performance indicators.
21+
22+
<!-- expires 2025-10-23 -->
23+
24+
>[!NOTE] This report is replacing the {% data variables.product.prodname_copilot_short %} **usage report**. The new report adds clarity by introducing authentication information and improving timestamp resolution. The old usage report is closing down and will be removed on October 23rd, 2025.
25+
26+
<!-- end expires 2025-10-23 -->
27+
28+
## Downloading the report for an enterprise
29+
30+
1. Navigate to your enterprise account.
31+
{% data reusables.enterprise-accounts.policies-tab %}
32+
{% data reusables.enterprise-accounts.copilot-tab %}
33+
1. Next to "Access management", click **Activity report**.
34+
35+
![Screenshot of the "Access management" tab in Copilot policies. The "Activity report" button is highlighted with an orange outline.](/assets/images/help/copilot/activity-report-enterprise.png)
36+
37+
## Downloading the report for an organization
38+
39+
1. Navigate to your organization settings.
40+
1. In the left sidebar, click **Copilot**, then click **Access**.
41+
1. Click **Get activity report**.
42+
43+
![Screenshot of the "Access" page. The "Get activity report" button is highlighted with an orange outline.](/assets/images/help/copilot/activity-report-org.png)
44+
45+
## Downloading the report for a non-GHE enterprise
46+
47+
These instructions apply if GitHub has provisioned you with a dedicated enterprise account for managing Copilot Business licenses. See [AUTOTITLE](/enterprise-cloud@latest/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).
48+
49+
1. Navigate to your enterprise account.
50+
1. At the top of the page, click **{% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} Billing and licensing**.
51+
1. Click **Manage seats**.
52+
1. Click **Get activity report**.
53+
54+
![Screenshot of the licensing page for Copilot Business. The "Get activity report" button is highlighted with an orange outline.](/assets/images/help/copilot/activity-report-non-ghe.png)
55+
56+
## Report fields
57+
58+
For field definitions and details of included features, see [AUTOTITLE](/copilot/reference/metrics-data#copilot-activity-report).

content/copilot/how-tos/administer/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@ topics:
99
children:
1010
- /organizations
1111
- /enterprises
12+
- /download-activity-report
1213
---
1314

content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ redirect_from:
1818
- /copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization
1919
---
2020

21-
## Reviewing user activity data for {% data variables.product.prodname_copilot_short %}
22-
2321
{% data reusables.profile.access_org %}
2422
{% data reusables.profile.org_settings %}
2523
{% data reusables.copilot.access-settings %}
@@ -31,11 +29,14 @@ redirect_from:
3129
![Screenshot of the {% data variables.product.prodname_copilot %} usage overview.](/assets/images/help/copilot/copilot-usage-overview.png)
3230
{% endif %}
3331

34-
1. For more detailed information, next to "Access management," click **Get report**.
32+
1. Alternatively, under "Access management," you can use the **Sort** options to sort the list of users by when they last used {% data variables.product.prodname_copilot %}.
33+
1. For more detailed information, you can retrieve the **Activity report**. {% data variables.product.prodname_dotcom %} generates a report for you, which you can download as a CSV file.
34+
35+
<!-- expires 2025-10-23 -->
3536

36-
{% data variables.product.prodname_dotcom %} generates a report for you, which you can download as a CSV file.
37+
>[!NOTE] This report is replacing the {% data variables.product.prodname_copilot_short %} **usage report**. The new report adds clarity by introducing authentication information and improving timestamp resolution. The old usage report is closing down and will be removed on October 23rd, 2025.
3738
38-
1. Alternatively, under "Access management," you can use the **Sort** options to sort the list of users by when they last used {% data variables.product.prodname_copilot %}.
39+
<!-- end expires 2025-10-23 -->
3940

4041
## Using the API to retrieve assignment information
4142

@@ -45,7 +46,7 @@ You can use {% data variables.product.prodname_dotcom %}'s REST API to get detai
4546

4647
If you believe a user's `last_activity_at` date should be more recent than shown in the CSV or API report, wait 24 hours and check again. If their recent Copilot usage is still not reflected in their `last_activity_at` date, have the user check that telemetry is enabled in their IDE settings.
4748

48-
For more information about this property, see [AUTOTITLE](/copilot/reference/metrics-data#last_activity_at).
49+
For more information about this property and other data in the activity report, see [AUTOTITLE](/copilot/reference/metrics-data).
4950

5051
## Further reading
5152

content/copilot/reference/metrics-data.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,41 @@ Processing new telemetry events and updating a user's `last_activity_at` date ca
4444
* After 90 days of no new activity, a user's `last_activity_at` value is set to `nil`.
4545

4646
For more information, see [Updating retention period for `last_activity_at` values on the Copilot user management API to 90 days](https://github.blog/changelog/2025-01-17-updating-retention-period-for-last_activity_at-values-on-the-user-management-api-public-preview-to-90-days/) on {% data variables.product.prodname_blog %}.
47+
48+
## Copilot activity report
49+
50+
The Copilot activity report shows user activity data for an organization or enterprise.
51+
52+
Data in the report refreshes automatically every 30 minutes.
53+
54+
### Fields
55+
56+
| Field | Description |
57+
|-------|-------------|
58+
| `report_time` | UTC timestamp when the report was generated |
59+
| `login` | GitHub username of the Copilot user |
60+
| `last_authenticated_at` | UTC timestamp of the user's most recent authentication |
61+
| `last_activity_at` | UTC timestamp of the user's most recent Copilot interaction |
62+
| `last_surface_used` | The Copilot feature used most recently:<br><ul><li>**IDE**: Editor name and version (e.g. "VS Code 1.89.1")</li><li>**GitHub.com**: Feature name (e.g., "Copilot Chat")</li><li>**Unspecified**: When IDE details are unavailable or no recent activity exists</ul> |
63+
64+
### Included features
65+
66+
The activity report provides visibility into usage of all generally available (GA) GitHub Copilot features in the IDE, on GitHub, in GitHub CLI, and on GitHub Mobile.
67+
68+
#### IDE features
69+
70+
* Code completions and Next edit suggestions
71+
* Copilot Chat
72+
* Copilot agents
73+
74+
#### GitHub features
75+
76+
* Copilot Chat
77+
* Copilot for Docs
78+
* Knowledge base management
79+
* Copilot pull requests
80+
* Copilot code reviews
81+
82+
### Retention period
83+
84+
Activity and authentication data are retained for a rolling 90-day period, consistent with the `last_activity_at` field.

0 commit comments

Comments
 (0)