Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions content/rest/copilot/copilot-metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: REST API endpoints for Copilot metrics
shortTitle: Copilot metrics
intro: Use the REST API to view Copilot metrics.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghec: '*'
topics:
- API
autogenerated: rest
allowTitleToDifferFromFilename: true
---

<!-- Content after this section is automatically generated -->
1 change: 1 addition & 0 deletions content/rest/copilot/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ topics:
autogenerated: rest
allowTitleToDifferFromFilename: true
children:
- /copilot-metrics
- /copilot-usage
- /copilot-user-management
versions:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,15 @@
"additional-permissions": true,
"access": "write"
},
{
"category": "copilot",
"slug": "get-copilot-metrics-for-an-organization",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/metrics",
"additional-permissions": true,
"access": "read"
},
{
"category": "copilot",
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
Expand Down Expand Up @@ -462,6 +471,15 @@
"additional-permissions": false,
"access": "read"
},
{
"category": "copilot",
"slug": "get-copilot-metrics-for-a-team",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
"additional-permissions": true,
"access": "read"
},
{
"category": "copilot",
"slug": "get-a-summary-of-copilot-usage-for-a-team",
Expand Down Expand Up @@ -690,6 +708,15 @@
"additional-permissions": true,
"access": "write"
},
{
"category": "copilot",
"slug": "get-copilot-metrics-for-an-organization",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/metrics",
"additional-permissions": true,
"access": "read"
},
{
"category": "copilot",
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
Expand All @@ -708,6 +735,15 @@
"additional-permissions": true,
"access": "read"
},
{
"category": "copilot",
"slug": "get-copilot-metrics-for-a-team",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
"additional-permissions": true,
"access": "read"
},
{
"category": "copilot",
"slug": "get-a-summary-of-copilot-usage-for-a-team",
Expand Down
12 changes: 12 additions & 0 deletions src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json
Original file line number Diff line number Diff line change
Expand Up @@ -2030,6 +2030,12 @@
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
},
{
"slug": "get-copilot-metrics-for-an-organization",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/metrics"
},
{
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
"subcategory": "copilot-usage",
Expand All @@ -2042,6 +2048,12 @@
"verb": "get",
"requestPath": "/orgs/{org}/members/{username}/copilot"
},
{
"slug": "get-copilot-metrics-for-a-team",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
},
{
"slug": "get-a-summary-of-copilot-usage-for-a-team",
"subcategory": "copilot-usage",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,17 @@
"server-to-server": false,
"additional-permissions": false
},
{
"category": "copilot",
"slug": "get-copilot-metrics-for-an-enterprise",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/copilot/metrics",
"access": "read",
"user-to-server": false,
"server-to-server": false,
"additional-permissions": false
},
{
"category": "copilot",
"slug": "get-a-summary-of-copilot-usage-for-enterprise-members",
Expand All @@ -25,6 +36,17 @@
"server-to-server": false,
"additional-permissions": false
},
{
"category": "copilot",
"slug": "get-copilot-metrics-for-an-enterprise-team",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics",
"access": "read",
"user-to-server": false,
"server-to-server": false,
"additional-permissions": false
},
{
"category": "copilot",
"slug": "get-a-summary-of-copilot-usage-for-an-enterprise-team",
Expand Down Expand Up @@ -394,6 +416,17 @@
"server-to-server": true,
"additional-permissions": true
},
{
"category": "copilot",
"slug": "get-copilot-metrics-for-an-organization",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/metrics",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": true
},
{
"category": "copilot",
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
Expand Down Expand Up @@ -603,6 +636,17 @@
"server-to-server": true,
"additional-permissions": false
},
{
"category": "copilot",
"slug": "get-copilot-metrics-for-a-team",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": true
},
{
"category": "copilot",
"slug": "get-a-summary-of-copilot-usage-for-a-team",
Expand Down Expand Up @@ -875,6 +919,17 @@
"server-to-server": true,
"additional-permissions": true
},
{
"category": "copilot",
"slug": "get-copilot-metrics-for-an-organization",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/metrics",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": true
},
{
"category": "copilot",
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
Expand All @@ -897,6 +952,17 @@
"server-to-server": true,
"additional-permissions": true
},
{
"category": "copilot",
"slug": "get-copilot-metrics-for-a-team",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": true
},
{
"category": "copilot",
"slug": "get-a-summary-of-copilot-usage-for-a-team",
Expand Down
12 changes: 12 additions & 0 deletions src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json
Original file line number Diff line number Diff line change
Expand Up @@ -1758,6 +1758,12 @@
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
},
{
"slug": "get-copilot-metrics-for-an-organization",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/metrics"
},
{
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
"subcategory": "copilot-usage",
Expand All @@ -1770,6 +1776,12 @@
"verb": "get",
"requestPath": "/orgs/{org}/members/{username}/copilot"
},
{
"slug": "get-copilot-metrics-for-a-team",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
},
{
"slug": "get-a-summary-of-copilot-usage-for-a-team",
"subcategory": "copilot-usage",
Expand Down
12 changes: 12 additions & 0 deletions src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json
Original file line number Diff line number Diff line change
Expand Up @@ -2030,6 +2030,12 @@
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
},
{
"slug": "get-copilot-metrics-for-an-organization",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/metrics"
},
{
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
"subcategory": "copilot-usage",
Expand All @@ -2042,6 +2048,12 @@
"verb": "get",
"requestPath": "/orgs/{org}/members/{username}/copilot"
},
{
"slug": "get-copilot-metrics-for-a-team",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
},
{
"slug": "get-a-summary-of-copilot-usage-for-a-team",
"subcategory": "copilot-usage",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -522,6 +522,15 @@
"additional-permissions": true,
"access": "write"
},
{
"category": "copilot",
"slug": "get-copilot-metrics-for-an-organization",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/metrics",
"additional-permissions": true,
"access": "read"
},
{
"category": "copilot",
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
Expand Down Expand Up @@ -765,6 +774,15 @@
"additional-permissions": false,
"access": "read"
},
{
"category": "copilot",
"slug": "get-copilot-metrics-for-a-team",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
"additional-permissions": true,
"access": "read"
},
{
"category": "copilot",
"slug": "get-a-summary-of-copilot-usage-for-a-team",
Expand Down Expand Up @@ -1143,6 +1161,15 @@
"additional-permissions": true,
"access": "write"
},
{
"category": "copilot",
"slug": "get-copilot-metrics-for-an-organization",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/metrics",
"additional-permissions": true,
"access": "read"
},
{
"category": "copilot",
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
Expand All @@ -1161,6 +1188,15 @@
"additional-permissions": true,
"access": "read"
},
{
"category": "copilot",
"slug": "get-copilot-metrics-for-a-team",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
"additional-permissions": true,
"access": "read"
},
{
"category": "copilot",
"slug": "get-a-summary-of-copilot-usage-for-a-team",
Expand Down
12 changes: 12 additions & 0 deletions src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
Original file line number Diff line number Diff line change
Expand Up @@ -2068,6 +2068,12 @@
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
},
{
"slug": "get-copilot-metrics-for-an-organization",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/metrics"
},
{
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
"subcategory": "copilot-usage",
Expand All @@ -2080,6 +2086,12 @@
"verb": "get",
"requestPath": "/orgs/{org}/members/{username}/copilot"
},
{
"slug": "get-copilot-metrics-for-a-team",
"subcategory": "copilot-metrics",
"verb": "get",
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
},
{
"slug": "get-a-summary-of-copilot-usage-for-a-team",
"subcategory": "copilot-usage",
Expand Down
Loading
Loading