REST API endpoints for admin stats
Use the REST API to retrieve a variety of metrics about your installation.
About admin stats
These endpoints are only available to authenticated site administrators. Normal users will receive a 404
response.
These endpoints only support authentication using a personal access token (classic). For more information, see "Managing your personal access tokens."
Get all statistics
Fine-grained access tokens for "Get all statistics"
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
HTTP response status codes for "Get all statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get all statistics"
Request example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprise/stats/all
Response
Status: 200
{
"repos": {
"total_repos": 212,
"root_repos": 194,
"fork_repos": 18,
"org_repos": 51,
"total_pushes": 3082,
"total_wikis": 15
},
"hooks": {
"total_hooks": 27,
"active_hooks": 23,
"inactive_hooks": 4
},
"pages": {
"total_pages": 36
},
"orgs": {
"total_orgs": 33,
"disabled_orgs": 0,
"total_teams": 60,
"total_team_members": 314
},
"users": {
"total_users": 254,
"admin_users": 45,
"suspended_users": 21
},
"pulls": {
"total_pulls": 86,
"merged_pulls": 60,
"mergeable_pulls": 21,
"unmergeable_pulls": 3
},
"issues": {
"total_issues": 179,
"open_issues": 83,
"closed_issues": 96
},
"milestones": {
"total_milestones": 7,
"open_milestones": 6,
"closed_milestones": 1
},
"gists": {
"total_gists": 178,
"private_gists": 151,
"public_gists": 25
},
"comments": {
"total_commit_comments": 6,
"total_gist_comments": 28,
"total_issue_comments": 366,
"total_pull_request_comments": 30
}
}
Get comment statistics
Fine-grained access tokens for "Get comment statistics"
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
HTTP response status codes for "Get comment statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get comment statistics"
Request example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprise/stats/comments
Response
Status: 200
{
"total_commit_comments": 5000,
"total_gist_comments": 400,
"total_issue_comments": 10900,
"total_pull_request_comments": 9900
}
Get gist statistics
Fine-grained access tokens for "Get gist statistics"
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
HTTP response status codes for "Get gist statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get gist statistics"
Request example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprise/stats/gists
Response
Status: 200
{
"total_gists": 500,
"private_gists": 30,
"public_gists": 470
}
Get hooks statistics
Fine-grained access tokens for "Get hooks statistics"
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
HTTP response status codes for "Get hooks statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get hooks statistics"
Request example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprise/stats/hooks
Response
Status: 200
{
"total_hooks": 50,
"active_hooks": 47,
"inactive_hooks": 3
}
Get issue statistics
Fine-grained access tokens for "Get issue statistics"
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
HTTP response status codes for "Get issue statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get issue statistics"
Request example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprise/stats/issues
Response
Status: 200
{
"total_issues": 5000,
"open_issues": 300,
"closed_issues": 4700
}
Get milestone statistics
Fine-grained access tokens for "Get milestone statistics"
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
HTTP response status codes for "Get milestone statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get milestone statistics"
Request example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprise/stats/milestones
Response
Status: 200
{
"total_milestones": 90,
"open_milestones": 10,
"closed_milestones": 80
}
Get organization statistics
Fine-grained access tokens for "Get organization statistics"
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
HTTP response status codes for "Get organization statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get organization statistics"
Request example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprise/stats/orgs
Response
Status: 200
{
"total_orgs": 50,
"disabled_orgs": 1,
"total_teams": 70,
"total_team_members": 700
}
Get pages statistics
Fine-grained access tokens for "Get pages statistics"
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
HTTP response status codes for "Get pages statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get pages statistics"
Request example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprise/stats/pages
Response
Status: 200
{
"total_pages": 20
}
Get pull request statistics
Fine-grained access tokens for "Get pull request statistics"
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
HTTP response status codes for "Get pull request statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get pull request statistics"
Request example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprise/stats/pulls
Response
Status: 200
{
"total_pulls": 1200,
"merged_pulls": 1100,
"mergeable_pulls": 90,
"unmergeable_pulls": 10
}
Get repository statistics
Fine-grained access tokens for "Get repository statistics"
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
HTTP response status codes for "Get repository statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get repository statistics"
Request example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprise/stats/repos
Response
Status: 200
{
"total_repos": 200,
"root_repos": 1,
"fork_repos": 10,
"org_repos": 150,
"total_pushes": 39000,
"total_wikis": 5
}
Get security products statistics
Gets the statistics about security products for a GitHub Enterprise Server instance.
To use this endpoint, you must be a site admin.
Fine-grained access tokens for "Get security products statistics"
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
HTTP response status codes for "Get security products statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get security products statistics"
Request example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprise/stats/security-products
Response
Status: 200
{
"total_repos": 150,
"nonarchived_repos": 130,
"secret_scanning_enabled_repos": 150,
"secret_scanning_push_protection_enabled_repos": 120,
"code_scanning_enabled_repos": 140,
"code_scanning_pr_reviews_enabled_repos": 100,
"code_scanning_default_setup_enabled_repos": 50,
"code_scanning_default_setup_eligible_repos": 30,
"dependabot_alerts_enabled_repos": 130,
"dependabot_security_updates_enabled_repos": 120,
"dependabot_version_updates_enabled_repos": 121,
"advanced_security_enabled_repos": 150,
"active_committers": 30,
"purchased_committers": 90,
"maximum_committers": 80
}
Get users statistics
Fine-grained access tokens for "Get users statistics"
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
HTTP response status codes for "Get users statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get users statistics"
Request example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprise/stats/users
Response
Status: 200
{
"total_users": 100,
"admin_users": 3,
"suspended_users": 1
}