The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Maximum value is 28 days ago.
Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.
The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise administration\" business permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly enterprise owners and billing managers can view Copilot metrics for the enterprise.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics", + "title": "Get Copilot metrics for an enterprise team", + "category": "copilot", + "subcategory": "copilot-metrics", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the enterprise team name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Maximum value is 28 days ago.
Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.
The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise administration\" business permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "team_slug": "TEAM_SLUG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nNote
\n\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot/metrics", + "title": "Get Copilot metrics for an organization", + "category": "copilot", + "subcategory": "copilot-metrics", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Maximum value is 28 days ago.
Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.
The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "read" + }, + { + "\"Administration\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nNote
\n\nThis endpoint will only return results for a given day if the organization contained five or more members with active Copilot licenses on that day, as evaluated at the end of that day.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.
OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics", + "title": "Get Copilot metrics for a team", + "category": "copilot", + "subcategory": "copilot-metrics", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Maximum value is 28 days ago.
Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.
The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "read" + }, + { + "\"Administration\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "team_slug": "TEAM_SLUG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nNote
\n\nThis endpoint will only return results for a given day if the team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.
OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + } + ], "copilot-usage": [ { "serverUrl": "https://api.github.com", @@ -357067,7 +359411,7 @@ } ], "previews": [], - "descriptionHTML": "List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Maximum value is 28 days ago.
Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.
The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise administration\" business permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly enterprise owners and billing managers can view Copilot metrics for the enterprise.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics", + "title": "Get Copilot metrics for an enterprise team", + "category": "copilot", + "subcategory": "copilot-metrics", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the enterprise team name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Maximum value is 28 days ago.
Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.
The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise administration\" business permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "team_slug": "TEAM_SLUG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nNote
\n\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot/metrics", + "title": "Get Copilot metrics for an organization", + "category": "copilot", + "subcategory": "copilot-metrics", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Maximum value is 28 days ago.
Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.
The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "read" + }, + { + "\"Administration\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nNote
\n\nThis endpoint will only return results for a given day if the organization contained five or more members with active Copilot licenses on that day, as evaluated at the end of that day.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.
OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics", + "title": "Get Copilot metrics for a team", + "category": "copilot", + "subcategory": "copilot-metrics", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Maximum value is 28 days ago.
Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.
The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"GitHub Copilot Business\" organization permissions": "read" + }, + { + "\"Administration\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "team_slug": "TEAM_SLUG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nNote
\n\nThis endpoint will only return results for a given day if the team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.
OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + } + ], "copilot-usage": [ { "serverUrl": "https://api.github.com", @@ -374750,7 +377094,7 @@ } ], "previews": [], - "descriptionHTML": "List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.