GitHub Copilot usage REST API [private preview]

Note: These endpoints are in private preview and are subject to change

You can use these endpoints to see a daily breakdown of aggregated Copilot usage metrics across your organization or enterprise members for the past 28 days, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. The usage metrics are processed once per day for the previous day, and the response will only include data up until yesterday.

Get a summary of Copilot usage for organization members

get/orgs/{org}/copilot/usage

Gets a summary of Copilot usage across all organization members, with a breakdown by language and editor.

You must be an owner or billing manager of an organization with a Copilot Business subscription, or an owner or billing manager of its parent enterprise, to view Copilot usage metrics.

You can authenticate using an access token with the copilot, manage_billing:copilot, admin:org, admin:enterprise, or manage_billing:enterprise scopes to use this endpoint.

Headers

Name	Type	Description
`accept`	string	Setting to `application/vnd.github+json` is recommended.

Path parameters

Name	Type	Required	Description
`org`	string	Yes	The organization name. The name is not case sensitive.

Example Response

[
  {
    "day": "2023-10-15",
    "total_suggestions_count": 1000,
    "total_acceptances_count": 800,
    "total_lines_suggested": 1800,
    "total_lines_accepted": 1200,
    "total_active_users": 8,
    "breakdown": [
      {
        "language": "python",
        "editor": "vscode",
        "suggestions_count": 300,
        "acceptances_count": 250,
        "lines_suggested": 900,
        "lines_accepted": 700,
        "active_users": 5
      },
      {
        "language": "python",
        "editor": "jetbrains",
        "suggestions_count": 300,
        "acceptances_count": 200,
        "lines_suggested": 400,
        "lines_accepted": 300,
        "active_users": 2
      },
      {
        "language": "ruby",
        "editor": "vscode",
        "suggestions_count": 400,
        "acceptances_count": 350,
        "lines_suggested": 500,
        "lines_accepted": 200,
        "active_users": 4
      }
    ]
  },
  {
    "day": "2023-10-14",
    "total_suggestions_count": 800,
    "total_acceptances_count": 500,
    "total_lines_suggested": 1100,
    "total_lines_accepted": 700,
    "total_active_users": 8,
    "breakdown": [
      {
        "language": "python",
        "editor": "vscode",
        "suggestions_count": 300,
        "acceptances_count": 200,
        "lines_suggested": 600,
        "lines_accepted": 300,
        "active_users": 2
      },
      {
        "language": "python",
        "editor": "jetbrains",
        "suggestions_count": 300,
        "acceptances_count": 150,
        "lines_suggested": 300,
        "lines_accepted": 250,
        "active_users": 6
      },
      {
        "language": "ruby",
        "editor": "vscode",
        "suggestions_count": 200,
        "acceptances_count": 150,
        "lines_suggested": 200,
        "lines_accepted": 150,
        "active_users": 3
      }
    ]
  }
]

Code Samples

cURL

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/copilot/usage

JavaScript

// Octokit.js
// https://github.com/octokit/core.js#readme
const octokit = new Octokit({
  auth: 'YOUR-TOKEN'
})

await octokit.request('GET /orgs/{org}/copilot/usage', {
  org: 'ORG',
  headers: {
    'X-GitHub-Api-Version': '2022-11-28'
  }
})

GitHub CLI

# GitHub CLI api
# https://cli.github.com/manual/gh_api

gh api \
  -H "Accept: application/vnd.github+json" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  /orgs/ORG/copilot/usage

Get a summary of Copilot usage for enterprise members

get/enterprises/{enterprise}/copilot/usage

Gets a summary of Copilot usage for members of all Copilot Business enabled organizations within the enterprise, with a breakdown by language and editor.

You must be an owner or billing manager of an enterprise with a Copilot Business subscription to view Copilot usage metrics.

You can authenticate using an access token with the copilot, manage_billing:copilot, admin:enterprise, or manage_billing:enterprise scopes to use this endpoint.