Endpoints da API REST para estatísticas de administração
Use a API REST para recuperar uma variedade de métricas sobre sua instalação.
Sobre as estatísticas de administração
Esses endpoints só estão disponíveis para administradores de site autenticados. Os usuários normais receberão uma resposta 404.
Observação
Esses pontos de extremidade só dão suporte à autenticação por meio de um personal access token (classic). Para saber mais, confira Gerenciar seus tokens de acesso pessoal.
Get all statistics
Tokens de acesso granular para "Get all statistics"
Este endpoint não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal com controle refinado.
Códigos de status de resposta HTTP para "Get all statistics"
| Código de status | Descrição |
|---|---|
200 | OK |
Exemplos de código para "Get all statistics"
Exemplo de solicitação
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/allResponse
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
Tokens de acesso granular para "Get comment statistics"
Este endpoint não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal com controle refinado.
Códigos de status de resposta HTTP para "Get comment statistics"
| Código de status | Descrição |
|---|---|
200 | OK |
Exemplos de código para "Get comment statistics"
Exemplo de solicitação
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/commentsResponse
Status: 200{
"total_commit_comments": 5000,
"total_gist_comments": 400,
"total_issue_comments": 10900,
"total_pull_request_comments": 9900
}Get gist statistics
Tokens de acesso granular para "Get gist statistics"
Este endpoint não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal com controle refinado.
Códigos de status de resposta HTTP para "Get gist statistics"
| Código de status | Descrição |
|---|---|
200 | OK |
Exemplos de código para "Get gist statistics"
Exemplo de solicitação
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/gistsResponse
Status: 200{
"total_gists": 500,
"private_gists": 30,
"public_gists": 470
}Get hooks statistics
Tokens de acesso granular para "Get hooks statistics"
Este endpoint não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal com controle refinado.
Códigos de status de resposta HTTP para "Get hooks statistics"
| Código de status | Descrição |
|---|---|
200 | OK |
Exemplos de código para "Get hooks statistics"
Exemplo de solicitação
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/hooksResponse
Status: 200{
"total_hooks": 50,
"active_hooks": 47,
"inactive_hooks": 3
}Get issue statistics
Tokens de acesso granular para "Get issue statistics"
Este endpoint não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal com controle refinado.
Códigos de status de resposta HTTP para "Get issue statistics"
| Código de status | Descrição |
|---|---|
200 | OK |
Exemplos de código para "Get issue statistics"
Exemplo de solicitação
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/issuesResponse
Status: 200{
"total_issues": 5000,
"open_issues": 300,
"closed_issues": 4700
}Get milestone statistics
Tokens de acesso granular para "Get milestone statistics"
Este endpoint não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal com controle refinado.
Códigos de status de resposta HTTP para "Get milestone statistics"
| Código de status | Descrição |
|---|---|
200 | OK |
Exemplos de código para "Get milestone statistics"
Exemplo de solicitação
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/milestonesResponse
Status: 200{
"total_milestones": 90,
"open_milestones": 10,
"closed_milestones": 80
}Get organization statistics
Tokens de acesso granular para "Get organization statistics"
Este endpoint não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal com controle refinado.
Códigos de status de resposta HTTP para "Get organization statistics"
| Código de status | Descrição |
|---|---|
200 | OK |
Exemplos de código para "Get organization statistics"
Exemplo de solicitação
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/orgsResponse
Status: 200{
"total_orgs": 50,
"disabled_orgs": 1,
"total_teams": 70,
"total_team_members": 700
}Get pages statistics
Tokens de acesso granular para "Get pages statistics"
Este endpoint não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal com controle refinado.
Códigos de status de resposta HTTP para "Get pages statistics"
| Código de status | Descrição |
|---|---|
200 | OK |
Exemplos de código para "Get pages statistics"
Exemplo de solicitação
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/pagesResponse
Status: 200{
"total_pages": 20
}Get pull request statistics
Tokens de acesso granular para "Get pull request statistics"
Este endpoint não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal com controle refinado.
Códigos de status de resposta HTTP para "Get pull request statistics"
| Código de status | Descrição |
|---|---|
200 | OK |
Exemplos de código para "Get pull request statistics"
Exemplo de solicitação
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/pullsResponse
Status: 200{
"total_pulls": 1200,
"merged_pulls": 1100,
"mergeable_pulls": 90,
"unmergeable_pulls": 10
}Get repository statistics
Tokens de acesso granular para "Get repository statistics"
Este endpoint não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal com controle refinado.
Códigos de status de resposta HTTP para "Get repository statistics"
| Código de status | Descrição |
|---|---|
200 | OK |
Exemplos de código para "Get repository statistics"
Exemplo de solicitação
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/reposResponse
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.
Tokens de acesso granular para "Get security products statistics"
Este endpoint não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal com controle refinado.
Códigos de status de resposta HTTP para "Get security products statistics"
| Código de status | Descrição |
|---|---|
200 | OK |
Exemplos de código para "Get security products statistics"
Exemplo de solicitação
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-productsResponse
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,
"secret_protection_licenses": 0,
"secret_protection_active_committers": 0,
"code_security_licenses": 0,
"code_security_active_committers": 0
}Get users statistics
Tokens de acesso granular para "Get users statistics"
Este endpoint não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal com controle refinado.
Códigos de status de resposta HTTP para "Get users statistics"
| Código de status | Descrição |
|---|---|
200 | OK |
Exemplos de código para "Get users statistics"
Exemplo de solicitação
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/usersResponse
Status: 200{
"total_users": 100,
"admin_users": 3,
"suspended_users": 1
}