By enabling the GitHub Copilot Usage connector allows you to import data on usage of GitHub Copilot at the user level. Please refer to the API documentation below for more details, and visit our <a href="https://app.getdx.com/datacloud/schema?tableName=github_copilot_daily_usages" rel="nofollow noopener noreferrer" target="_blank">schema explorer</a> to see what data DX imports.

a GitHub account that is an <a href="https://docs.github.com/en/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owners" rel="nofollow noopener noreferrer" target="_blank">Enterprise Owner</a> (not an Organization Owner)

a <a href="https://docs.github.com/en/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#configuring-policies-for-github-copilot" rel="nofollow noopener noreferrer" target="_blank">Copilot metrics API access policy</a> must be enabled for your enterprise

if your GitHub instance is behind a firewall or has IP restrictions, you need to allowlist <a href="https://help.getdx.com/en/articles/8487041-connections-to-on-prem-tools">DX IP addresses</a>

- a GitHub account that is an <a href="https://docs.github.com/en/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owners" rel="nofollow noopener noreferrer" target="_blank">Enterprise Owner</a> (not an Organization Owner)
- a <a href="https://docs.github.com/en/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#configuring-policies-for-github-copilot" rel="nofollow noopener noreferrer" target="_blank">Copilot metrics API access policy</a> must be enabled for your enterprise
- if your GitHub instance is behind a firewall or has IP restrictions, you need to allowlist <a href="https://help.getdx.com/en/articles/8487041-connections-to-on-prem-tools">DX IP addresses</a>

Follow the steps below to connect GitHub to DX.

Navigate to Settings -&gt; Developer Settings -&gt; Personal Access Token.

Click on Token (classic) and generate new token (classic). Either the manage_billing:copilot or read:enterprise scope is required.

Navigate to the connector setup form in DX.

Enter the credentials you have generated in the previous steps—refer to the information below for errors and troubleshooting.

1. Navigate to the connector setup form in DX.
2. Enter the credentials you have generated in the previous steps—refer to the information below for errors and troubleshooting.

The table below lists the specific API endpoints that are used by DX.

Note: To access copilot/metrics endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. Only enterprise owners and billing managers can view Copilot metrics for the enterprise.

The table below lists potential error codes when adding a connection in DX.

I'm seeing "no_resource" error from API response

This indicates that you don’t have admin access to the enterprise account. To verify it’s working correctly, you can try the following curl request:

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer &lt;YOUR-TOKEN&gt;" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/copilot/billing/seats

Replace ENTERPRISE with your enterprise slug and use your PAT in the Authorization header. Note that a Github organization is not an Enterprise.

Endpoint	Reference
/enterprises/ENTERPRISE/copilot/billing/seats	List all Copilot seat assignments for an enterprise
/enterprises/ENTERPRISE/copilot/metrics	List Copilot metrics for an enterprise

Error	Description
`invalid_credentials`	Your API credentials entered are not valid.
`invalid_permissions`	Your API token does not have the permissions required by DX—please verify that your service account is an Enterprise Owner.

Prerequisites

Setup instructions

Step 1

Step 2

Step 3

API Reference

Troubleshooting

I'm seeing "no_resource" error from API response