🚀GitHub Copilot Metrics API GA release now available

[Akash1134]

🆕 Update: Feb 2025

Beginning February 2025, the beta Copilot /usage endpoints will be deprecated. See details

🚀 Now Available: GitHub Copilot Metrics API in General Availability! 🚀

We’re thrilled to introduce the GA release of the GitHub Copilot Metrics API, now open to all GitHub Copilot Business and GitHub Copilot Enterprise users. This release is packed with features to give you greater visibility into Copilot's impact across your development workflow. Ready to dive into the data?

---

📊 What’s the GitHub Copilot Metrics API?

Imagine having detailed insights into how Copilot is being used across your enterprise. The Metrics API brings this to life by providing you with data on Copilot's usage—across teams, organizations, and individual features. Perfect for tracking trends, understanding usage patterns, and integrating with your own dashboards, the Metrics API helps you see where Copilot is adding value and how you can optimize its use.

🎉 What's New in the GA Release?

Here’s a peek at what’s included:

• New metrics for Pull Request summaries and Copilot Chat on GitHub.com.
• Clarity on code completions and Copilot Chat usage in IDEs.
• User engagement summaries updated daily.
• Custom model slicing support, coming soon!
• Data is aggregated by enterprise, organization, and team.
• Up to 28 days of historical data available for trend analysis.

With data loaded daily (UTC) and summarized by day, you can view patterns in real-time and make more data-informed decisions.

🤔 Will My Current Reporting Be Affected?

To make the transition smooth, we’ve kept the Beta route online through the end of the year. This means any current reporting tied to the Beta API will continue without interruption, while you explore the newly revised schema and expanded metrics in the GA version.

📚 Resources to Get Started

• Docs: Ready to get started? Explore the API documentation for the full breakdown of metrics and schema.

---

💬 Your Turn!

How are you planning to use the Copilot Metrics API? What specific metrics would give you the best insight into Copilot's impact on your projects? Whether it’s tracking usage, surfacing adoption trends, or something else entirely, we’d love to hear your ideas. Drop your thoughts below and let’s shape the future of Copilot analytics together! 👇

[AppSecCharlie]

@Akash1134 This looks great, would love to see more detailed metrics about Copilot usage and engagement.

Question: it looks like this is disabled for my org, do I need an enterprise owner to enable? The docs are a little light but it sounds like if I get an enterprise owner to enable the Copilot Metrics API for the enterprise I can then get them for my org?

To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.

[samus-aran]

Hi @charlieW33,

Yes, you would need to enable at the Enterprise level. 👍

[DevOps-zhuang]

based on my test, billing manager itself is not enought, it needs owner role for the organization

[DevOps-zhuang]

Thanks for the GA, it looks more detailed, and indeeed more complex :-)
like for the previous usage route, it displays the aggregate code summary data for each day, then break down it by editor/language.

day": "2023-10-15",
    **"total_suggestions_count": 5000,
    "total_acceptances_count": 3000,
    "total_lines_suggested": 7000,
    "total_lines_accepted": 3500,**
    "total_active_users": 15,
    "total_chat_acceptances": 45,
    "total_chat_turns": 350,
    "total_active_chat_users": 8,

for the GA metric route, I was doubting whether we still need an aggregate high-leve total_code summary for each day, maybe per day per language? currently, for the copilot_ide_code_completions part, it only has one direct KV which is "total_engaged_users": 20. in order to get the total_code_* metircs as before, we have to check the breakdown data, which is by editor/models/language, the merge them togeterh. based on my observation, the total_code_* data per day per language is a strong requirement. so it is better to add it. thanks for your consideration.

like currently, for the lanuages part under "copilot_ide_code_completions", it only display the total_engaged_users part, is it possible to add total_code_* part for each language? thanks.

"copilot_ide_code_completions": {
"total_engaged_users": 20,
"languages": [
{
"name": "python",
"total_engaged_users": 10
},
{
"name": "ruby",
"total_engaged_users": 10
}
],

[DevOps-zhuang]

and the other consideration is about the 'engaged user' and 'active users', to be honest, I am not quite understand the difference, and I am still oberving and check the difference.

[rhlbhatnagar]

Hey,
While using this API I get:

"Your organization has disabled Copilot Metrics API access. Enable it in GitHub settings to access this endpoint."

In github settings I'm unable to enable access to the metrics API as admin. I see a link to a doc on how for github pre release license terms
https://docs.github.com/en/site-policy/github-terms/github-pre-release-license-terms

But don't actually see how to get my enterprise access to these pre release features.

[veverkap]

You need to go into your enterprise settings first (https://github.com/enterprises/{YOUR_ENTERPRISE_SLUG}/settings/copilot?tab=policies) and chose either "No Policy" or "Enabled"

If you chose "Enabled", then the policy is enabled for all organizations and they cannot change the setting at the organizaiton level.

If you chose "No Policy", then the policy is configurable at the organization level (https://github.com/organizations/{YOUR_ORGANIZATION}/settings/copilot/policies

[rajeshharne]

Accessing GitHub Copilot Usage API with a Business Account – Is it supported?

Question: @Akash1134 / Team

Hello everyone,

I’m looking to track GitHub Copilot usage metrics through the API for our organization, which currently has a GitHub Business license. Specifically, I’d like to use the following endpoint:

/enterprises/{enterprise}/copilot/usage

Before diving in, I wanted to confirm: does the GitHub Business license provide access to the Copilot usage API, or is this feature exclusively available for GitHub Enterprise accounts? If it’s enterprise-only, are there any alternative methods for tracking Copilot usage in a Business account?

Thanks for any insights or guidance!

[veverkap]

Yes, a Copilot Business subscription with users is all that is needed.

[karpikpl]

how to access new metrics?
the docs say

To make the transition smooth, we’ve kept the Beta route online through the end of the year.
what's the difference between beta route and new route?

I get old data for
x-github-api-version-selected: 2022-11-28
GET https://api.github.com/orgs//copilot/usage

also the link to the documentation doesn't work

[DevOps-zhuang]

copilot/usage is the old usage API. and copilot/metrics is the new one

[karpikpl]

lol, thanks. I don't know how I missed that :)

[DevOps-zhuang]

we found some data issues, the total_suggested is also 0. though there are accepated, can you double check the data quality?
the data is as below:
"copilot_ide_code_completions": {
"editors": [
{
"name": "vscode",
"models": [
{
"name": "default",
"languages": [
{
"name": "typescript",
"total_engaged_users": 1,
"total_code_acceptances": 39,
"total_code_suggestions": 0,
"total_code_lines_accepted": 22,
"total_code_lines_suggested": 0
}
],
"is_custom_model": false,
"total_engaged_users": 1
}
],
"total_engaged_users": 1
}
],
"languages": [
{
"name": "typescript",
"total_engaged_users": 1
}
],
"total_engaged_users": 1
}
},

[DevOps-zhuang]

and "copilot_ide_code_completions": {
"editors": [
{
"name": "JetBrains",
"models": [
{
"name": "default",
"languages": [
{
"name": "java",
"total_engaged_users": 1,
"total_code_acceptances": 8,
"total_code_suggestions": 0,
"total_code_lines_accepted": 19,
"total_code_lines_suggested": 0
}
],
"is_custom_model": false,
"total_engaged_users": 1
}
],
"total_engaged_users": 1
}
],

[karpikpl]

I think we've seen similar issues in sample data and API data before this was GA :(

[DevOps-zhuang]

I think we've seen similar issues in sample data and API data before this was GA :(

Yes, we see different issues. hope it can be solved ASAP. since it is GAed, good quality is hoped.

[levanvunam]

I tried to use the billing/seats endpoint and seems like the "assigning_team" of member is always missing, trying to export csv from the interface also show no team, anyone has similar problem?

[DevOps-zhuang]

I tried to use the billing/seats endpoint and seems like the "assigning_team" of member is always missing, trying to export csv from the interface also show no team, anyone has similar problem?

I met the same issue before, and then found out that it is because the 'assigning_team' is the team where the user got the copilot license, that means, we need to assign the license to the individual by teams, not to the indiviual directly. ony with this way, you can get the assigning_team, it is not the team the copilot seats belong to... and I do think this design is some strange, if it can be updated to the team the user currently in, it is better. and will be align with the usage/metrics API>

[Apokalypt]

Hello,
Recently, Github announced the fact that different models could be used in chat (GTP-4o, o1, o3-mini, ...) or even in code completion (GPT-3.5 Turbo, GPT-4o). However, I have the impression that the API doesn't detail this information ... Indeed, since we enabled it I know that some of my collaborators use “o1” while others use “GTP-4o” but in the model names returned by the /metrics API, we only see “default”.

Is this intentional or am I just not looking where I should?

[Madeleinetaya]

Still remain "default" for us until now

[Apokalypt]

That's what we see too ...
@Akash1134 is it intended ?

[aaron-seitz]

I had a question about this myself today - looking at the main post at the top, it says that "Custom model slicing support, coming soon!", so it's on their radar - hopefully they'll be rolling it out sometime soon (along with team-level data, which we're hoping for 🤞🏻)

[Apokalypt]

I had a question about this myself today - looking at the main post at the top, it says that "Custom model slicing support, coming soon!", so it's on their radar - hopefully they'll be rolling it out sometime soon (along with team-level data, which we're hoping for 🤞🏻)

Custom model is something different already available : https://docs.github.com/en/enterprise-cloud@latest/copilot/customizing-copilot/creating-a-custom-model-for-github-copilot

I'm not talking about custom model but about models that are "offered" by Github right now 👍

[pixelxiao]

i am the owner of org, but i still can not enable it, the button is gray

[karpikpl]

it has to be enabled in the enterprise for org owners to be able to select it

[radnus888]

I am using the Copilot Metrics API to fetch data, but I have noticed that it only allows fetching up to 28 days of historical data. However, I need to access the complete historical data using this API. When I tried using the Copilot Usage API to retrieve the historical data, I encountered issues. Can you help me understand whether it is possible to fetch the complete historical data, or if there are any limitations?

[Coppac]

I am having this exact same issue. I have to keep reinstalling the App every month just to keep current data but it won't fetch data after that initial month. How can we resolve this urgently please as this is keeping the tool from being useful?

[ingo]

Does the PowerBI dashboard allow you to see data by team?

[Coppac]

I am also interested in this. We're looking to organize the data by team but also by users Is there a way to do this?

[connor-dawson]

Hi,

We've setup the GitHub Copilot Metrics PowerBI app for our GitHub enterprise. In our enterprise we have two organizations. This is reflected in the app however it seems the Organization slicer on the 'Adoption Metrics', 'Usage Metrics', and 'Data Tables' pages doesn't filter the data.

When switching between our organizations using the slicer our data is not filtered. However on the 'Org Usage Metrics' page the data is filtered when using the organization slicer.

Is this a known issue and are there plans to fix it?

Thank you

[mccmar]

hello everyone, not clear for me the difference about total_active_users (copilot/metrics), active_this_cycle/inactive_this_cycle (copilot/billing) and last_activity_at (billing/seats). thanks in advance

[mccmar]

hi at all, I have another question. the response schema of enterprises/ENTERPRISE/copilot/metrics and ORG/copilot/metrics produce the same result. how to differentiate the organization inside the enterprise structure? thanks in advance

[jboulware]

@Akash1134 Your PowerBI app is broken since Github updated the advanced_security endpoint. See: https://github.com/orgs/community/discussions/145645#discussioncomment-12805328

[Coppac]

Every 28 days my Copilot Metrics fails to refresh the data and it requires it to be removed and reinstalled to continue getting the data from my environment. I've verified the PAT used is working for other functions and hasn't changed and the error I receive is:

Data source error: DataSource.Error: Web.Contents failed to get contents from 'https://api.github.com/enterprises/vantiva-emu/settings/billing/advanced-security' (422): Unprocessable Entity. Microsoft.Data.Mashup.ErrorCode = 10117. DataSourceKind = Web. DataSourcePath = https://api.github.com/enterprises/vantiva-emu/settings/billing/advanced-security. Url = https://api.github.com/enterprises/vantiva-emu/settings/billing/advanced-security. . The exception was raised by the IDbCommand interface.
Cluster URI: WABI-US-CENTRAL-B-PRIMARY-redirect.analysis.windows.net
Activity ID: c7743cc2-74c2-3b71-852c-577f36a35ca7
Request ID: f42b6a95-d070-ea9a-07cf-132a7ad9a9b0
Time: 2025-04-21 16:52:27Z

This tool provides no value if I have to reinstall once a month. Please provide a solution.

[gyanpenrose-kafka]

Everything was working, but then stopped. I tried updating the app, but data refresh still failed. Yesterday, I tried installing the app from scratch, but it won't connect to the data. I am not sure why or what's happening since there are no error messages.

[DevOps-zhuang]

maybe the token is outofdate? suggest to check the error message first

[nikolai-svalebaek]

I get this error again. We had this in the previous version as well. But after updating it does not work any more :(

[fkenji-fuji]

In Power BI Desktop it is loading the data, but when it publish to the web it is giving the following error.

_The credentials provided for the Web source are invalid. (Source at https://api.github.com/orgs/ORG/copilot/metrics.). The exception was raised by the IDbCommand interface. Table: GH Copilot - summary._

Please provide a solution.

[SakharamS]

Error fetching data for this visual

The expression referenced a relationship between 'CopilotEnterpriseStats'[enterprise] and 'EnterpriseLicenses'[enterprise], which does not hold any data because it needs to be recalculated.
Please check the technical details for more information. If you contact support, please provide these details.
Hide details
Underlying ErrorQueryUserError
Activity ID9aab78f2-1656-4e38-ac2e-80d4569bb9ca
Correlation IDb13a69f3-a0fe-de00-0abd-d960e0416b3c
Request ID18caf88d-4577-dcd0-dbed-be4af14e6d70
TimeFri Sep 05 2025 02:47:32 GMT+0530 (India Standard Time)
Service version13.0.26550.40
Client version2508.3.25682-train
Cluster URIhttps://wabi-us-east2-c-primary-redirect.analysis.windows.net/ -- I am getting this error with the latest version for this PowerBI App. I did enable the API metrics at the enterprise level.

[VictorMoni]

Amazing, thanks for the update 😁👍❤️

[itayang]

Hi, this API is great !

I have a couple of questions / suggestions:

• Now that the new dashboard is GA (https://github.blog/changelog/2025-10-28-copilot-usage-metrics-dashboard-and-api-in-public-preview/)
  is there a change to get the data from the API ?
  Can we have a team-level granularity there too please ?
  One of the major differences in my eyes is that the dashboard includes agent usage too and the API doesn't.

Another thing that we (And I assume a lot of others) will find valuable too is metrics about actual code integration - as in:
How much code that got suggested + accepted eventually made it to production (or to a pull request / merge to main) ?
How much of it got reverted later ?

We're tracking our teams usage and correlate the AI adoption trend with other metrics under the 'velocity' or 'quality' umbrella and the above will help us a great deal.

[mccmar]

Hi, very useful info about the user's usage.

If I understand well these new rest api integrate the previous.
Another point is that I view a lot of unknowns on feature_language and feature_model data.

Thanks