org_copilot_user_usage_metrics
Creates, updates, deletes, gets or lists an org_copilot_user_usage_metrics resource.
Overview
| Name | org_copilot_user_usage_metrics |
| Type | Resource |
| Id | github.copilot.org_copilot_user_usage_metrics |
Fields
The following fields are returned by SELECT queries:
- copilot_organization_users_usage_metrics
Response
| Name | Datatype | Description |
|---|---|---|
download_links | array | The URLs to download the latest Copilot usage metrics report for the enterprise/organization. |
report_end_day | string (date) | The end date of the report period in YYYY-MM-DD format. |
report_start_day | string (date) | The start date of the report period in YYYY-MM-DD format. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
copilot_organization_users_usage_metrics | select | org | Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization. The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.For more information about organization metrics attribution, see How are metrics attributed across organizations. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
org | string | The organization name. The name is not case sensitive. |
SELECT examples
- copilot_organization_users_usage_metrics
Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.
The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.
Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.
Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
For more information about organization metrics attribution, see How are metrics attributed across organizations.
SELECT
download_links,
report_end_day,
report_start_day
FROM github.copilot.org_copilot_user_usage_metrics
WHERE org = '{{ org }}' -- required
;