We’re excited to announce the GA release of the GitHub Copilot Metrics API, available to all customers of GitHub Copilot Business and GitHub Copilot Enterprise.
What is the Copilot Metrics API?
The GitHub Copilot Metrics API is designed to supply you with information about Copilot’s usage within your GitHub enterprise, organizations, and teams. The data from the API is intended to be consumed and combined with your organization’s own data to create greater visibility into how Copilot fits into the bigger picture of your software development cycle. It offers visibility into utilization of individual Copilot features and the volume of daily active users.
What’s included in the GA release?
- New metrics for Pull Request summaries.
- New metrics for Copilot Chat in GitHub.com.
- Improved clarity for code completions and Copilot Chat in IDE metrics.
- Daily summary of total engaged users.
- Built in support for slicing data on custom models, arriving shortly after release.
- Aggregation by GitHub enterprise, organization, and team.
- Up to 28 days of history is available.
- Metrics are loaded end of day UTC, and are summarized by day.
- Terminology alignment with the User Management API.
Will my current reporting be impacted?
The GA release of the Copilot Metrics API introduces a newly revised schema which preserves all of the concepts from the preview, while expanding the contents in new ways. With the GA release, the preview route (/usage
) is now closing down . To ensure that your existing reports are not interrupted, the preview route will remain online through January 31, 2025, when it will be retired.
Documentation and Resources
- Docs: Explore detailed API documentation, including schema and metrics definitions here.
- Questions or suggestions? Join the community conversation.