We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the Actions REST API page.
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.
Get all statistics
HTTP response status codes for "Get all statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get all statistics"
get/enterprise/stats/all
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://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
HTTP response status codes for "Get comment statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get comment statistics"
get /enterprise /stats /comments
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://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
HTTP response status codes for "Get gist statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get gist statistics"
get/enterprise/stats/gists
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/enterprise/stats/gists
Response
Status: 200
{
"total_gists": 500,
"private_gists": 30,
"public_gists": 470
}
Get hooks statistics
HTTP response status codes for "Get hooks statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get hooks statistics"
get/enterprise/stats/hooks
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/enterprise/stats/hooks
Response
Status: 200
{
"total_hooks": 50,
"active_hooks": 47,
"inactive_hooks": 3
}
Get issue statistics
HTTP response status codes for "Get issue statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get issue statistics"
get/enterprise/stats/issues
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/enterprise/stats/issues
Response
Status: 200
{
"total_issues": 5000,
"open_issues": 300,
"closed_issues": 4700
}
Get milestone statistics
HTTP response status codes for "Get milestone statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get milestone statistics"
get /enterprise /stats /milestones
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/enterprise/stats/milestones
Response
Status: 200
{
"total_milestones": 90,
"open_milestones": 10,
"closed_milestones": 80
}
Get organization statistics
HTTP response status codes for "Get organization statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get organization statistics"
get/enterprise/stats/orgs
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://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
HTTP response status codes for "Get pages statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get pages statistics"
get/enterprise/stats/pages
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/enterprise/stats/pages
Response
Status: 200
{
"total_pages": 20
}
Get pull request statistics
HTTP response status codes for "Get pull request statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get pull request statistics"
get/enterprise/stats/pulls
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/enterprise/stats/pulls
Response
Status: 200
{
"total_pulls": 1200,
"merged_pulls": 1100,
"mergeable_pulls": 90,
"unmergeable_pulls": 10
}
Get repository statistics
HTTP response status codes for "Get repository statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get repository statistics"
get/enterprise/stats/repos
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://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 users statistics
HTTP response status codes for "Get users statistics"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get users statistics"
get/enterprise/stats/users
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/enterprise/stats/users
Response
Status: 200
{
"total_users": 100,
"admin_users": 3,
"suspended_users": 1
}