コミュニティのメトリクス
この REST API を使って、コミュニティ プロファイルに関する情報を取得します。
Get community profile metrics
Returns all community profile metrics for a repository. The repository cannot be a fork.
The returned metrics include an overall health score, the repository description, the presence of documentation, the detected code of conduct, the detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE, README, and CONTRIBUTING files.
The health_percentage score is defined as a percentage of how many of
these four documents are present: README, CONTRIBUTING, LICENSE, and
CODE_OF_CONDUCT. For example, if all four documents are present, then
the health_percentage is 100. If only one is present, then the
health_percentage is 25.
content_reports_enabled is only returned for organization-owned repositories.
"Get community profile metrics" のパラメーター
| ヘッダー |
|---|
| 名前, Type, 説明 |
accept string Setting to |
| パス パラメーター |
| 名前, Type, 説明 |
owner string 必須The account owner of the repository. The name is not case sensitive. |
repo string 必須The name of the repository. The name is not case sensitive. |
"Get community profile metrics" の HTTP 応答状態コード
| 状態コード | 説明 |
|---|---|
200 | OK |
"Get community profile metrics" のコード サンプル
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/repos/OWNER/REPO/community/profileResponse
Status: 200{
"health_percentage": 100,
"description": "My first repository on GitHub!",
"documentation": null,
"files": {
"code_of_conduct": {
"name": "Contributor Covenant",
"key": "contributor_covenant",
"url": "https://api.github.com/codes_of_conduct/contributor_covenant",
"html_url": "https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md"
},
"code_of_conduct_file": {
"url": "https://api.github.com/repos/octocat/Hello-World/contents/CODE_OF_CONDUCT.md",
"html_url": "https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md"
},
"contributing": {
"url": "https://api.github.com/repos/octocat/Hello-World/contents/CONTRIBUTING",
"html_url": "https://github.com/octocat/Hello-World/blob/master/CONTRIBUTING"
},
"issue_template": {
"url": "https://api.github.com/repos/octocat/Hello-World/contents/ISSUE_TEMPLATE",
"html_url": "https://github.com/octocat/Hello-World/blob/master/ISSUE_TEMPLATE"
},
"pull_request_template": {
"url": "https://api.github.com/repos/octocat/Hello-World/contents/PULL_REQUEST_TEMPLATE",
"html_url": "https://github.com/octocat/Hello-World/blob/master/PULL_REQUEST_TEMPLATE"
},
"license": {
"name": "MIT License",
"key": "mit",
"spdx_id": "MIT",
"url": "https://api.github.com/licenses/mit",
"html_url": "https://github.com/octocat/Hello-World/blob/master/LICENSE",
"node_id": "MDc6TGljZW5zZW1pdA=="
},
"readme": {
"url": "https://api.github.com/repos/octocat/Hello-World/contents/README.md",
"html_url": "https://github.com/octocat/Hello-World/blob/master/README.md"
}
},
"updated_at": "2017-02-28T19:09:29Z",
"content_reports_enabled": true
}