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 APIs.

Enterprise APIs:

GET /enterprises/{enterprise}/copilot/metrics
GET /enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest

Organization APIs:

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 a GitHub App, a Personal Access Token (PAT), or a combination of both.

Method	GitHub App	Personal Access Token (PAT	GitHub App + PAT
Best For	Companies using GitHub as their SCM.	Companies managing Copilot licenses using GitHub Enterprise and working in another SCM like GitLab or ADO.	Companies using GitHub that also want to track user usage and more advanced data.
Access Expiration	Does not expire.	Requires you to set an expiration date and periodically refresh the token.	Requires you to set an expiration date and periodically refresh the token.
APIs Accessed	Organization APIs	Enterprise APIs (includes user-level data)	Organization + Enterprise APIs

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.

Connecting via GitHub App

If you have a GitHub organization, we strongly recommend using our GitHub App, which will also enable tracking of productivity metrics. You can always connect via GitHub PAT separately to increase the telemetry data we collect for GitHub Copilot.

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.

Connecting via Personal Access Token (PAT)

Before you get started, you must enable Copilot usage metrics in your enterprise. By default, Copilot usage metrics are disabled. Enterprise admins can enable them as follows:

Navigate to your AI Controls tab on github.com.
Select Copilot in the left sidebar.
Scroll down to the “Metrics” section where you’ll see Copilot usage metrics.
Change the Copilot usage metrics policy setting to Enabled. This will enable the Copilot APIs for your enterprise, allowing enterprise administrators and billing managers to view usage and adoption data.

The authenticated user must be an enterprise owner or billing manager to use these endpoints. OAuth app tokens and personal access tokens (classic) need the manage_billing:copilot and read:enterprise scopes.

read:enterprise

This scope provides read-only access to enterprise-level data on GitHub Enterprise. This is a restrictive scope that only allows viewing/listing enterprise data, not modifying it. Does not include profile data of enterprise members or organizations.

manage_billing:copilot

This scope provides the ability to view and edit Copilot Business seat assignments. It is the most restrictive scope that provides access to Copilot metadata.