We’re excited to announce the public beta of the GitHub Copilot Metrics API, available to all customers of GitHub Copilot Business and GitHub Copilot Enterprise starting today.
The GitHub Copilot Metrics API is designed to supply you with information about Copilot’s usage within your organizations. 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.
What functionality will be included in the Public Beta?
- Historical data will be automatically loaded, giving you the ability to overlay data with any previous sources from day one.
-
The endpoint will supply data for the previous 28 days of usage history, on a rolling basis.
-
Data is summarized by day, and is refreshed at day end.
-
Date ranges and pagination are now available.
-
This iteration of the GitHub Copilot Metrics API is focused on serving metrics for Copilot Chat and code completions that take place in the IDE.
-
Code completion metrics: Lines of Code Suggested, Lines of Code Accepted, Number of Suggestions, Number of Acceptances, and Active Users with slices on language, and IDE.
-
Copilot Chat metrics: Number of Chats, Chat Suggestions Accepted, and Active Users. The endpoint does not currently feature slices on language or IDE for Chat metrics.
-
Team-level aggregates for GitHub teams with five or more members are also available.
Documentation and Resources
To help you get started, we have prepared comprehensive documentation and resources:
- API Documentation: Explore the detailed API documentation, including metrics definitions here.
-
Visualization: You can find an open source tool for consuming and visualizing data from the endpoint here.
-
Metrics Export: Generate a flattened CSV from the endpoint using GitHub Actions here.
-
Learning Pathway: You can find an extended article on measuring the impact of GitHub Copilot here.
Participate in the Public Beta!
Your feedback during this beta phase is invaluable to us. We encourage you to share your experiences, which will be instrumental in refining and enhancing the API as we look toward the future.
Stay tuned for updates and enhancements throughout the beta period. We’re committed to delivering a robust and feature-rich API that meets your needs and expectations.**