# Конечные точки REST API для метрик использования Copilot

Используйте REST API для просмотра Copilot метрик использования.

Для включения этих конечных точек политика «Copilot метрики использования» должна быть установлена как **Включена везде** для предприятия. См [. раздел AUTOTITLE](/ru/enterprise-cloud@latest/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies#defining-policies-for-your-enterprise).

Для получения дополнительной информации о метриках, возвращаемых этими конечными точками, см. [AUTOTITLE.](/ru/enterprise-cloud@latest/copilot/reference/copilot-usage-metrics)

> \[!NOTE]
> Most endpoints use `Authorization: Bearer <YOUR-TOKEN>` and `Accept: application/vnd.github+json` headers, plus `X-GitHub-Api-Version: 2022-11-28`. Curl examples below omit these standard headers for brevity.

## Get Copilot enterprise usage metrics for a specific day

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

Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise.
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. 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.

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`enterprise`** (string) (required)
  The slug version of the enterprise name.

* **`day`** (string) (required)
  The day to request data for, in YYYY-MM-DD format.

### HTTP response status codes

* **200** - OK

* **403** - Forbidden

* **404** - Resource not found

* **500** - Internal Error

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/enterprises/ENTERPRISE/copilot/metrics/reports/enterprise-1-day
```

**Response schema (Status: 200):**

* `download_links`: required, array of string, format: uri
* `report_day`: required, string, format: date

## Get Copilot enterprise usage metrics

```
GET /enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest
```

Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise.
The report contains aggregated metrics for the previous 28 days, 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 range covered by the report. The report covers a complete 28-day period ending on the most recent 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

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`enterprise`** (string) (required)
  The slug version of the enterprise name.

### HTTP response status codes

* **200** - OK

* **403** - Forbidden

* **404** - Resource not found

* **500** - Internal Error

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/enterprises/ENTERPRISE/copilot/metrics/reports/enterprise-28-day/latest
```

**Response schema (Status: 200):**

* `download_links`: required, array of string, format: uri
* `report_start_day`: required, string, format: date
* `report_end_day`: required, string, format: date

## Get Copilot enterprise repository report for a specific day

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

Use this endpoint to retrieve download links for the Copilot enterprise repository report for a specific day. The report provides per-repository pull request metrics for Copilot across the enterprise, with one entry per repository.
The report contains repository-level pull request activity for the specified day, including the Copilot Coding Agent (CCA) and Copilot Code Review (CCR) breakdowns. Only repositories that had activity on the specified day are included. 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

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`enterprise`** (string) (required)
  The slug version of the enterprise name.

* **`day`** (string) (required)
  The day to request data for, in YYYY-MM-DD format.

### HTTP response status codes

* **200** - OK

* **204** - A header with no content is returned.

* **403** - Forbidden

* **404** - Resource not found

* **500** - Internal Error

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/enterprises/ENTERPRISE/copilot/metrics/reports/repos-1-day
```

**Response schema (Status: 200):**

Same response schema as [Get Copilot enterprise usage metrics for a specific day](#get-copilot-enterprise-usage-metrics-for-a-specific-day).

## Get Copilot enterprise user-teams report for a specific day

```
GET /enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-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

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`enterprise`** (string) (required)
  The slug version of the enterprise name.

* **`day`** (string) (required)
  The day to request data for, in YYYY-MM-DD format.

### HTTP response status codes

* **200** - OK

* **403** - Forbidden

* **404** - Resource not found

* **500** - Internal Error

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/enterprises/ENTERPRISE/copilot/metrics/reports/user-teams-1-day
```

**Response schema (Status: 200):**

Same response schema as [Get Copilot enterprise usage metrics for a specific day](#get-copilot-enterprise-usage-metrics-for-a-specific-day).

## 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.

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`enterprise`** (string) (required)
  The slug version of the enterprise name.

* **`day`** (string) (required)
  The day to request data for, in YYYY-MM-DD format.

### HTTP response status codes

* **200** - OK

* **403** - Forbidden

* **404** - Resource not found

* **500** - Internal Error

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/enterprises/ENTERPRISE/copilot/metrics/reports/users-1-day
```

**Response schema (Status: 200):**

Same response schema as [Get Copilot enterprise usage metrics for a specific day](#get-copilot-enterprise-usage-metrics-for-a-specific-day).

## Get Copilot users usage metrics

```
GET /enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest
```

Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. 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 previous 28 days, 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 range covered by the report. The report covers a complete 28-day period ending on the most recent 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

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`enterprise`** (string) (required)
  The slug version of the enterprise name.

### HTTP response status codes

* **200** - OK

* **403** - Forbidden

* **404** - Resource not found

* **500** - Internal Error

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/enterprises/ENTERPRISE/copilot/metrics/reports/users-28-day/latest
```

**Response schema (Status: 200):**

Same response schema as [Get Copilot enterprise usage metrics](#get-copilot-enterprise-usage-metrics).

## Get Copilot usage records for an enterprise

```
GET /enterprises/{enterprise}/copilot/usage-records
```

Note

This endpoint is in public preview and is subject to change.

Use this endpoint to retrieve Copilot agent session activity records for a specific enterprise. The endpoint provides comprehensive observability into Copilot session data across your enterprise.
The response includes detailed usage records aggregated and forwarded from all Copilot clients where your end users operate under enterprise-paid Copilot licenses. This includes cloud agents operating on github.com and data resident deployments on ghe.com, Copilot CLI, VS Code, Visual Studio, and partner IDEs such as those provided by JetBrains and Eclipse.
Only EMU (GHEC and GHEC with Data Residency) enterprise owners can access this endpoint.
OAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`enterprise`** (string) (required)
  The slug version of the enterprise name.

* **`phrase`** (string)
  A search phrase to filter usage records. Supported qualifiers: type (request/response), user\_id, created.

* **`per_page`** (integer)
  The number of results per page (max 25). Values are clamped to the range \[1, 25].
  Default: `25`

* **`after`** (string)
  A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

* **`before`** (string)
  A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

* **`order`** (string)
  The order of audit log events. To list newest events first, specify desc. To list oldest events first, specify asc.
  The default is desc.
  Can be one of: `desc`, `asc`

### HTTP response status codes

* **200** - OK

* **400** - Bad Request

* **403** - Forbidden

* **404** - Resource not found

* **422** - Validation failed, or the endpoint has been spammed.

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/enterprises/ENTERPRISE/copilot/usage-records
```

**Response schema (Status: 200):**

Array of objects:

* `type`: string
* `user_id`: integer
* `enterprise_id`: integer
* `github_request_id`: string
* `endpoint`: string
* `body`: string
* `@timestamp`: integer
* `event_id`: string

## Get Copilot organization usage metrics for a specific day

```
GET /orgs/{org}/copilot/metrics/reports/organization-1-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

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`org`** (string) (required)
  The organization name. The name is not case sensitive.

* **`day`** (string) (required)
  The day to request data for, in YYYY-MM-DD format.

### HTTP response status codes

* **200** - OK

* **204** - A header with no content is returned.

* **403** - Forbidden

* **404** - Resource not found

* **500** - Internal Error

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/orgs/ORG/copilot/metrics/reports/organization-1-day
```

**Response schema (Status: 200):**

Same response schema as [Get Copilot enterprise usage metrics for a specific day](#get-copilot-enterprise-usage-metrics-for-a-specific-day).

## Get Copilot organization usage metrics

```
GET /orgs/{org}/copilot/metrics/reports/organization-28-day/latest
```

Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.
The report contains aggregated metrics for the previous 28 days, 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 range covered by the report. The report covers a complete 28-day period ending on the most recent 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

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`org`** (string) (required)
  The organization name. The name is not case sensitive.

### HTTP response status codes

* **200** - OK

* **403** - Forbidden

* **404** - Resource not found

* **500** - Internal Error

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/orgs/ORG/copilot/metrics/reports/organization-28-day/latest
```

**Response schema (Status: 200):**

Same response schema as [Get Copilot enterprise usage metrics](#get-copilot-enterprise-usage-metrics).

## Get Copilot organization repository report for a specific day

```
GET /orgs/{org}/copilot/metrics/reports/repos-1-day
```

Use this endpoint to retrieve download links for the Copilot organization repository report for a specific day. The report provides per-repository pull request metrics for Copilot across the organization, with one entry per repository.
The report contains repository-level pull request activity for the specified day, including the Copilot Coding Agent (CCA) and Copilot Code Review (CCR) breakdowns. Only repositories that had activity on the specified day are included. 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

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`org`** (string) (required)
  The organization name. The name is not case sensitive.

* **`day`** (string) (required)
  The day to request data for, in YYYY-MM-DD format.

### HTTP response status codes

* **200** - OK

* **204** - A header with no content is returned.

* **403** - Forbidden

* **404** - Resource not found

* **500** - Internal Error

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/orgs/ORG/copilot/metrics/reports/repos-1-day
```

**Response schema (Status: 200):**

Same response schema as [Get Copilot enterprise usage metrics for a specific day](#get-copilot-enterprise-usage-metrics-for-a-specific-day).

## Get Copilot organization user-teams report for a specific day

```
GET /orgs/{org}/copilot/metrics/reports/user-teams-1-day
```

Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, 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 organization 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.
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

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`org`** (string) (required)
  The organization name. The name is not case sensitive.

* **`day`** (string) (required)
  The day to request data for, in YYYY-MM-DD format.

### HTTP response status codes

* **200** - OK

* **204** - A header with no content is returned.

* **403** - Forbidden

* **404** - Resource not found

* **500** - Internal Error

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/orgs/ORG/copilot/metrics/reports/user-teams-1-day
```

**Response schema (Status: 200):**

Same response schema as [Get Copilot enterprise usage metrics for a specific day](#get-copilot-enterprise-usage-metrics-for-a-specific-day).

## Get Copilot organization users usage metrics for a specific day

```
GET /orgs/{org}/copilot/metrics/reports/users-1-day
```

Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.
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.
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

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`org`** (string) (required)
  The organization name. The name is not case sensitive.

* **`day`** (string) (required)
  The day to request data for, in YYYY-MM-DD format.

### HTTP response status codes

* **200** - OK

* **204** - A header with no content is returned.

* **403** - Forbidden

* **404** - Resource not found

* **500** - Internal Error

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/orgs/ORG/copilot/metrics/reports/users-1-day
```

**Response schema (Status: 200):**

Same response schema as [Get Copilot enterprise usage metrics for a specific day](#get-copilot-enterprise-usage-metrics-for-a-specific-day).

## Get Copilot organization users usage metrics

```
GET /orgs/{org}/copilot/metrics/reports/users-28-day/latest
```

Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.
The report contains user-specific metrics for the previous 28 days, 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 range covered by the report. The report covers a complete 28-day period ending on the most recent 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

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`org`** (string) (required)
  The organization name. The name is not case sensitive.

### HTTP response status codes

* **200** - OK

* **403** - Forbidden

* **404** - Resource not found

* **500** - Internal Error

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/orgs/ORG/copilot/metrics/reports/users-28-day/latest
```

**Response schema (Status: 200):**

Same response schema as [Get Copilot enterprise usage metrics](#get-copilot-enterprise-usage-metrics).