Skip to content
forgit api docs

Get Copilot users usage metrics for a specific day

GET
/enterprises/{enterprise}/copilot/metrics/reports/users-1-day

Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.

The report contains user-specific metrics for the specified day, 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 of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.

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.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
enterprise
required
string

The slug version of the enterprise name.

Query Parameters

Section titled “ Query Parameters ”
day
required
string format: date
Example 
2025-10-13

The day to request data for, in YYYY-MM-DD format.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Copilot Metrics 1 Day Report

Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.

object
download_links
required

The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day.

Array<string>
report_day
required

The day of the report in YYYY-MM-DD format.

string format: date
Examples
Example default 
{
  "download_links": [
    "https://example.com/copilot-usage-report-1.ndjson",
    "https://example.com/copilot-usage-report-2.ndjson"
  ],
  "report_day": "2025-07-01"
}

403

Section titled “ 403 ”

Forbidden

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Section titled “ 404 ”

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

500

Section titled “ 500 ”

Internal Error

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}