4c9684f281
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>
85 lines
3.4 KiB
Markdown
85 lines
3.4 KiB
Markdown
---
|
|
title: Metrics data properties for GitHub Copilot
|
|
shortTitle: Metrics data
|
|
intro: 'See how GitHub calculates properties from APIs and reports.'
|
|
versions:
|
|
feature: copilot
|
|
topics:
|
|
- Copilot
|
|
allowTitleToDifferFromFilename: true
|
|
---
|
|
|
|
## `last_activity_at`
|
|
|
|
> [!NOTE] This data is in {% data variables.release-phases.public_preview %} and subject to change.
|
|
|
|
The timestamp of a user's most recent interaction with {% data variables.product.prodname_copilot_short %} functionality.
|
|
|
|
### Surfaces
|
|
|
|
This property is consistent across the following surfaces:
|
|
|
|
* The CSV report downloaded from the "Access management" page (see [AUTOTITLE](/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization))
|
|
* The [AUTOTITLE](/rest/copilot/copilot-user-management)
|
|
|
|
### Calculation
|
|
|
|
The following interactions count as activity:
|
|
|
|
* Receiving a code suggestion in an IDE
|
|
* Chatting with Copilot Chat in an IDE
|
|
* Creating or updating a knowledge base
|
|
* Creating a pull request summary
|
|
* Interacting with Copilot Chat in GitHub
|
|
* Interacting with Copilot on a mobile device
|
|
* Interacting with Copilot Chat for CLI
|
|
|
|
The tracked events come from both client- and server-side telemetry, ensuring the timestamp is durable if network conditions affect client-side telemetry.
|
|
|
|
Processing new telemetry events and updating a user's `last_activity_at` date can take up to 24 hours. Users must have telemetry enabled in their IDE for their usage to be reflected in `last_activity_at`.
|
|
|
|
### Retention period
|
|
|
|
* The retention period for `last_activity_at` data is 90 days. This cannot be modified.
|
|
* 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 %}.
|
|
|
|
## 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.
|