org_copilot_one_day_usage_metrics
Creates, updates, deletes, gets or lists an org_copilot_one_day_usage_metrics resource.
Overview
| Name | org_copilot_one_day_usage_metrics |
| Type | Resource |
| Id | github.copilot.org_copilot_one_day_usage_metrics |
Fields
The following fields are returned by SELECT queries:
- copilot_organization_one_day_usage_metrics
Response
| Name | Datatype | Description |
|---|---|---|
download_links | array | The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day. |
report_day | string (date) | The day of the report in YYYY-MM-DD format. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
copilot_organization_one_day_usage_metrics | select | org, day | Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization. The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. 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 of the report. The report covers a complete 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 |
|---|---|---|
day | string (date) | The day to request data for, in YYYY-MM-DD format. |
org | string | The organization name. The name is not case sensitive. |
SELECT examples
- copilot_organization_one_day_usage_metrics
Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.
The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. 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 of the report. The report covers a complete 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_day
FROM github.copilot.org_copilot_one_day_usage_metrics
WHERE org = '{{ org }}' -- required
AND day = '{{ day }}' -- required
;