Update user activity data section for GitHub Copilot... (#56708)
Co-authored-by: isaacmbrown <isaacmbrown@github.com> Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Co-authored-by: Lauren <79170249+laurenNYC@users.noreply.github.com>
This commit is contained in:
BIN
assets/images/help/copilot/activity-report-enterprise.png
Normal file
BIN
assets/images/help/copilot/activity-report-enterprise.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 193 KiB |
BIN
assets/images/help/copilot/activity-report-non-ghe.png
Normal file
BIN
assets/images/help/copilot/activity-report-non-ghe.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 108 KiB |
BIN
assets/images/help/copilot/activity-report-org.png
Normal file
BIN
assets/images/help/copilot/activity-report-org.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 79 KiB |
@@ -0,0 +1,58 @@
|
|||||||
|
---
|
||||||
|
title: Downloading a Copilot activity report for your organization or enterprise
|
||||||
|
intro: 'Monitor Copilot license usage with a detailed report.'
|
||||||
|
permissions: Enterprise owners and organization owners
|
||||||
|
product: '{% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %}'
|
||||||
|
versions:
|
||||||
|
feature: copilot
|
||||||
|
allowTitleToDifferFromFilename: true
|
||||||
|
type: how_to
|
||||||
|
topics:
|
||||||
|
- Copilot
|
||||||
|
- Enterprise
|
||||||
|
shortTitle: Download activity report
|
||||||
|
---
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
* Accurately monitor {% data variables.product.prodname_copilot_short %} license usage accurately.
|
||||||
|
* Understand patterns in user authentication.
|
||||||
|
* Manage licenses and measure key performance indicators.
|
||||||
|
|
||||||
|
<!-- expires 2025-10-23 -->
|
||||||
|
|
||||||
|
>[!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.
|
||||||
|
|
||||||
|
<!-- end expires 2025-10-23 -->
|
||||||
|
|
||||||
|
## Downloading the report for an enterprise
|
||||||
|
|
||||||
|
1. Navigate to your enterprise account.
|
||||||
|
{% data reusables.enterprise-accounts.policies-tab %}
|
||||||
|
{% data reusables.enterprise-accounts.copilot-tab %}
|
||||||
|
1. Next to "Access management", click **Activity report**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Downloading the report for an organization
|
||||||
|
|
||||||
|
1. Navigate to your organization settings.
|
||||||
|
1. In the left sidebar, click **Copilot**, then click **Access**.
|
||||||
|
1. Click **Get activity report**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Downloading the report for a non-GHE enterprise
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
1. Navigate to your enterprise account.
|
||||||
|
1. At the top of the page, click **{% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} Billing and licensing**.
|
||||||
|
1. Click **Manage seats**.
|
||||||
|
1. Click **Get activity report**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Report fields
|
||||||
|
|
||||||
|
For field definitions and details of included features, see [AUTOTITLE](/copilot/reference/metrics-data#copilot-activity-report).
|
||||||
@@ -9,5 +9,6 @@ topics:
|
|||||||
children:
|
children:
|
||||||
- /organizations
|
- /organizations
|
||||||
- /enterprises
|
- /enterprises
|
||||||
|
- /download-activity-report
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -18,8 +18,6 @@ redirect_from:
|
|||||||
- /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
|
- /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
|
||||||
---
|
---
|
||||||
|
|
||||||
## Reviewing user activity data for {% data variables.product.prodname_copilot_short %}
|
|
||||||
|
|
||||||
{% data reusables.profile.access_org %}
|
{% data reusables.profile.access_org %}
|
||||||
{% data reusables.profile.org_settings %}
|
{% data reusables.profile.org_settings %}
|
||||||
{% data reusables.copilot.access-settings %}
|
{% data reusables.copilot.access-settings %}
|
||||||
@@ -31,11 +29,14 @@ redirect_from:
|
|||||||

|

|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
1. For more detailed information, next to "Access management," click **Get report**.
|
|
||||||
|
|
||||||
{% data variables.product.prodname_dotcom %} generates a report for you, which you can download as a CSV file.
|
|
||||||
|
|
||||||
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 %}.
|
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 %}.
|
||||||
|
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.
|
||||||
|
|
||||||
|
<!-- expires 2025-10-23 -->
|
||||||
|
|
||||||
|
>[!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.
|
||||||
|
|
||||||
|
<!-- end expires 2025-10-23 -->
|
||||||
|
|
||||||
## Using the API to retrieve assignment information
|
## Using the API to retrieve assignment information
|
||||||
|
|
||||||
@@ -45,7 +46,7 @@ You can use {% data variables.product.prodname_dotcom %}'s REST API to get detai
|
|||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
For more information about this property, see [AUTOTITLE](/copilot/reference/metrics-data#last_activity_at).
|
For more information about this property and other data in the activity report, see [AUTOTITLE](/copilot/reference/metrics-data).
|
||||||
|
|
||||||
## Further reading
|
## Further reading
|
||||||
|
|
||||||
|
|||||||
@@ -44,3 +44,41 @@ Processing new telemetry events and updating a user's `last_activity_at` date ca
|
|||||||
* After 90 days of no new activity, a user's `last_activity_at` value is set to `nil`.
|
* After 90 days of no new activity, a user's `last_activity_at` value is set to `nil`.
|
||||||
|
|
||||||
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 %}.
|
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 %}.
|
||||||
|
|
||||||
|
## Copilot activity report
|
||||||
|
|
||||||
|
The Copilot activity report shows user activity data for an organization or enterprise.
|
||||||
|
|
||||||
|
Data in the report refreshes automatically every 30 minutes.
|
||||||
|
|
||||||
|
### Fields
|
||||||
|
|
||||||
|
| Field | Description |
|
||||||
|
|-------|-------------|
|
||||||
|
| `report_time` | UTC timestamp when the report was generated |
|
||||||
|
| `login` | GitHub username of the Copilot user |
|
||||||
|
| `last_authenticated_at` | UTC timestamp of the user's most recent authentication |
|
||||||
|
| `last_activity_at` | UTC timestamp of the user's most recent Copilot interaction |
|
||||||
|
| `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> |
|
||||||
|
|
||||||
|
### Included features
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
#### IDE features
|
||||||
|
|
||||||
|
* Code completions and Next edit suggestions
|
||||||
|
* Copilot Chat
|
||||||
|
* Copilot agents
|
||||||
|
|
||||||
|
#### GitHub features
|
||||||
|
|
||||||
|
* Copilot Chat
|
||||||
|
* Copilot for Docs
|
||||||
|
* Knowledge base management
|
||||||
|
* Copilot pull requests
|
||||||
|
* Copilot code reviews
|
||||||
|
|
||||||
|
### Retention period
|
||||||
|
|
||||||
|
Activity and authentication data are retained for a rolling 90-day period, consistent with the `last_activity_at` field.
|
||||||
|
|||||||
Reference in New Issue
Block a user