From 373f5fcb2d7637e8e5ad96cece342e9fd5ffa324 Mon Sep 17 00:00:00 2001 From: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Date: Tue, 4 Mar 2025 15:30:30 +0000 Subject: [PATCH] Add notes that the metrics API isn't on GHE.com (#54659) --- .../analyzing-usage-over-time-with-the-copilot-metrics-api.md | 4 +++- content/rest/copilot/copilot-metrics.md | 2 ++ data/reusables/copilot/metrics-api-ghecom.md | 1 + 3 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 data/reusables/copilot/metrics-api-ghecom.md diff --git a/content/copilot/rolling-out-github-copilot-at-scale/analyzing-usage-over-time-with-the-copilot-metrics-api.md b/content/copilot/rolling-out-github-copilot-at-scale/analyzing-usage-over-time-with-the-copilot-metrics-api.md index ab23d11c6b..7997b6c633 100644 --- a/content/copilot/rolling-out-github-copilot-at-scale/analyzing-usage-over-time-with-the-copilot-metrics-api.md +++ b/content/copilot/rolling-out-github-copilot-at-scale/analyzing-usage-over-time-with-the-copilot-metrics-api.md @@ -30,11 +30,13 @@ This guide demonstrates how to query the API, store data, and analyze a trend fo ## About endpoint availability -Endpoints are available to get data for an enterprise, organization, organization team, or enterprise team. +Endpoints are available to get data for an enterprise, organization, organization team, or enterprise team on {% data variables.product.prodname_dotcom_the_website %}. * If you have a {% data variables.product.prodname_copilot_for_business %} or {% data variables.product.prodname_copilot_enterprise %} subscription as part of a regular organization or enterprise, you can use the endpoints for **an enterprise, an organization, or an organization team**. You don't have access to enterprise teams unless you're enrolled in a preview. * If you use a dedicated enterprise for {% data variables.product.prodname_copilot_for_business %}—an enterprise account without the ability to create organizations—you can use the endpoints for **an enterprise or an enterprise team**. +{% data reusables.copilot.metrics-api-ghecom %} + ## Prerequisites * The **{% data variables.product.prodname_copilot_short %} metrics API access** policy must be enabled for your enterprise or organization. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization) or [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise). diff --git a/content/rest/copilot/copilot-metrics.md b/content/rest/copilot/copilot-metrics.md index 7b69b6a668..d660a7f9a0 100644 --- a/content/rest/copilot/copilot-metrics.md +++ b/content/rest/copilot/copilot-metrics.md @@ -22,4 +22,6 @@ If you currently use the [AUTOTITLE](/rest/copilot/copilot-usage), we recommend For help getting started, see [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/analyzing-usage-over-time-with-the-copilot-metrics-api). +{% data reusables.copilot.metrics-api-ghecom %} + diff --git a/data/reusables/copilot/metrics-api-ghecom.md b/data/reusables/copilot/metrics-api-ghecom.md new file mode 100644 index 0000000000..ce6f064b63 --- /dev/null +++ b/data/reusables/copilot/metrics-api-ghecom.md @@ -0,0 +1 @@ +>[!NOTE] The {% data variables.product.prodname_copilot_short %} metrics endpoints are **not** available for {% data variables.enterprise.data_residency %} on {% data variables.enterprise.data_residency_site %}.