Sample - GitHub REST API
GET/orgs/{org}/copilot/metrics/reports/organization-1-day

Get Copilot organization usage metrics for a specific 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.

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

2 parameters
orgstringrequired
The organization name. The name is not case sensitive.
daystringrequired
The day to request data for, in `YYYY-MM-DD` format.

5 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.
204A header with no content is returned.
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.