Sample - GitHub REST API
GET/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day

Get Copilot enterprise user-teams report for a specific 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.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
enterprisestringrequired
The slug version of the enterprise name.
daystringrequired
The day to request data for, in `YYYY-MM-DD` format.

4 status codes
200Response
download_linksarray<string>required
The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day.
report_daystringrequired
The day of the report in `YYYY-MM-DD` format.
403Forbidden
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
500Internal Error
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 500 is returned: Internal Error.