管理统计
使用 REST API 检索有关安装的各种指标。
关于管理统计
这些终结点仅适用于经过身份验证的网站管理员。 普通用户将收到 404
响应。
这些终结点仅支持使用 personal access token (classic) 进行身份验证。 有关详细信息,请参阅“管理个人访问令牌”。
Get GitHub Enterprise Server statistics
Returns aggregate usage metrics for your GitHub Enterprise Server 3.5+ instance for a specified time period up to 365 days.
To use this endpoint, your GitHub Enterprise Server instance must be connected to GitHub Enterprise Cloud using GitHub Connect. You must enable Server Statistics, and for the API request provide your enterprise account name or organization name connected to the GitHub Enterprise Server. For more information, see "Enabling Server Statistics for your enterprise" in the GitHub Enterprise Server documentation.
You'll need to use a personal access token:
- If you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statistics, you'll need a personal access token with the
read:enterprise
permission. - If you connected your GitHub Enterprise Server to an organization account and enabled Server Statistics, you'll need a personal access token with the
read:org
permission.
For more information on creating a personal access token, see "Creating a personal access token."
“Get GitHub Enterprise Server statistics”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
enterprise_or_org string 必须The slug version of the enterprise name or the login of an organization. |
名称, 类型, 说明 |
---|
date_start string A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. |
date_end string A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. |
“Get GitHub Enterprise Server statistics”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
200 | OK |
“Get GitHub Enterprise Server statistics”的示例代码
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/enterprise-installation/ENTERPRISE_OR_ORG/server-statistics
Response
Status: 200
{
"server_id": "ea6088f3-f095-4bf2-8d7f-c573819e8768",
"collection_date": "2021-12-14T23:59:59Z",
"schema_version": "20230306",
"ghes_version": "3.9.0",
"host_name": "github.example.com",
"github_connect": {
"features_enabled": [
"license_usage_sync",
"content_analysis",
"content_analysis_notifications"
]
},
"ghe_stats": {
"comments": {
"total_commit_comments": 1000,
"total_gist_comments": 1000,
"total_issue_comments": 0,
"total_pull_request_comments": 0
},
"gists": {
"total_gists": 100,
"private_gists": 59,
"public_gists": 41
},
"hooks": {
"total_hooks": 2,
"active_hooks": 1,
"inactive_hooks": 1
},
"issues": {
"total_issues": 3421,
"open_issues": 1234,
"closed_issues": 1222
},
"milestones": {
"total_milestones": 50,
"open_milestones": 20,
"closed_milestones": 30
},
"orgs": {
"total_orgs": 100,
"disabled_orgs": 22,
"total_teams": 299,
"total_team_members": 400
},
"pages": {
"total_pages": 10
},
"pulls": {
"total_pulls": 1232,
"merged_pulls": 223,
"mergeable_pulls": 435,
"unmergeable_pulls": 0
},
"repos": {
"total_repos": 12,
"root_repos": 1,
"fork_repos": 2,
"org_repos": 1,
"total_pushes": 42,
"total_wikis": 1
},
"users": {
"total_users": 2000,
"admin_users": 299,
"suspended_users": 423
}
},
"dormant_users": {
"total_dormant_users": 5,
"dormancy_threshold": "90 days"
},
"actions_stats": {
"$ref": "server-statistics-actions.yaml"
},
"packages_stats": {
"$ref": "server-statistics-packages.yaml"
}
}