copilot_user_teams_one_day_report
Creates, updates, deletes, gets or lists a copilot_user_teams_one_day_report resource.
Overview
| Name | copilot_user_teams_one_day_report |
| Type | Resource |
| Id | github.copilot.copilot_user_teams_one_day_report |
Fields
The following fields are returned by SELECT queries:
- copilot_enterprise_user_teams_one_day_report
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_enterprise_user_teams_one_day_report | select | enterprise, day | Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair. The report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage 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. Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint. |
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. |
enterprise | string | The slug version of the enterprise name. |
SELECT examples
- copilot_enterprise_user_teams_one_day_report
Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair.
The report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage 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.
Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
SELECT
download_links,
report_day
FROM github.copilot.copilot_user_teams_one_day_report
WHERE enterprise = '{{ enterprise }}' -- required
AND day = '{{ day }}' -- required
;