Skip to content

Commit cedc7e4

Browse files
authored
Document API Insights hostname scope (#63696)
Copilot-Session: a934e31c-df06-4612-860b-422d1f3abf07 Copilot-Session: d30ae121-a6c6-4cec-a82a-4b240d0b8b02
1 parent b93d24a commit cedc7e4

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

‎content/organizations/managing-programmatic-access-to-your-organization/viewing-api-insights-in-your-organization.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ As a {% data variables.product.prodname_ghe_cloud %} organization owner, you and
1616

1717
> [!NOTE] Currently, this feature supports only the `core` category of REST API endpoints and primary rate limits. API activity for search, {% data variables.product.prodname_actions %} (using the [`GITHUB_TOKEN`](/actions/tutorials/authenticate-with-github_token) secret), and secondary rate-limiting are not supported. For information about API categories, see [AUTOTITLE](/rest/rate-limit/rate-limit). To learn more about primary and secondary rate limits, see [AUTOTITLE](/rest/using-the-rest-api/rate-limits-for-the-rest-api).
1818
19+
API insights only includes REST API requests sent to an API hostname, such as `api.github.com` or `api.SUBDOMAIN.ghe.com` for {% data variables.product.prodname_ghe_cloud %} with data residency. It does not include API routes served through a web hostname, such as `github.com` or `SUBDOMAIN.ghe.com`. For example, a `GET /user/repos` request sent to `SUBDOMAIN.ghe.com` is excluded from API insights.
20+
21+
Requests to API routes through a web hostname can consume the same primary rate limit as requests through an API hostname. As a result, the totals shown in API insights can be lower than the usage reported by `GET /rate_limit` or the `x-ratelimit-*` response headers. Ordinary web page loads, Git operations, and raw-content requests are also outside the scope of API insights.
22+
1923
## Enabling access to API insights
2024

2125
Organization owners can create custom organization roles to allow people to view API insights for their organization. To provide users with access, select the **View organization API insights** permission when creating a custom organization role. Then assign the custom role to an organization member or team. For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles).

0 commit comments

Comments
 (0)