GitHub Copilot
Software.com automatically tracks AI coding metrics directly from the GitHub Copilot usage APIs, giving you insight into adoption, activity, and the impact of AI tools on your team's productivity.
API Access Details
Our integration requires read-only access to the following GitHub Copilot usage APIs:
- GET /enterprises/{enterprise}/copilot/metrics
- GET /orgs/{org}/copilot/metrics
- GET /orgs/{org}/team/{team_slug}/copilot/metrics
- GET /orgs/{org}/copilot/billing
- GET /orgs/{org}/copilot/billing/seats
For more information, you can review the official GitHub Copilot REST API documentation.
Connection Methods
To enable this feature, connect your GitHub account. There are two methods for connecting, depending on whether you have a GitHub organization or manage Copilot licenses through GitHub enterprise.
You can connect Software.com to GitHub Copilot using either a GitHub App or a Personal Access Token (PAT).
| Method | GitHub App (Preferred method) | Personal Access Token |
|---|---|---|
| Best For | Companies using GitHub as their SCM. | Companies managing Copilot licenses using GitHub Enterprise and working in another SCM like GitLab or ADO. |
| Access Expiration | Does not expire. | Requires you to set an expiration date and periodically refresh the token. |
| APIs Accessed |
|
|
Important Notes:
- Billing and Seat Utilization Data: This data is only available at the organization level in GitHub. You will not see seat utilization metrics if you do not have a GitHub Organization.
- Team Data: If you have a GitHub Organization, we will also sync your GitHub Teams to help with analysis. Please note that we do not currently sync teams from the Enterprise level.
Method 1: Connecting via GitHub App (Preferred)
If you have a GitHub organization, we strongly recommend using our GitHub App.
To connect, simply install our official GitHub App while creating a Software.com organization. The connection is handled via OAuth and does not expire, providing continuous data syncing.
Method 2: Connecting via Personal Access Token (PAT)
Use this method if you do not have a GitHub organization and are managing Copilot with GitHub Enterprise.
- Navigate to Settings > Connected Apps in your Software.com account.
- Find GitHub Copilot Enterprise and click Connect.
- Create a PAT (Classic) in your GitHub account with the following two scopes: read:enterprise, manage_billing:copilot. These are required to access the Copilot usage API.
- When creating the token, set an Expiration date. We recommend setting a long expiration (e.g., 1 year) and creating a calendar reminder to refresh it before it expires.
- Enter your Enterprise Slug (this is the unique name of your enterprise in your GitHub URL: github.com/enterprises/YOUR-SLUG). The slug must match an enterprise that you can access.
Click Save to complete the connection.