Skip to main content
이제 REST API의 버전이 지정되었습니다. 자세한 내용은 "API 버전 관리 정보"를 참조하세요.

커뮤니티 메트릭에 대한 REST API 엔드포인트

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 the recommended community health files are present. For more information, see "About community profiles for public repositories."

content_reports_enabled is only returned for organization-owned repositories.

"Get community profile metrics"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 토큰 형식에서 작동합니다.:

토큰에 다음 권한 집합이 있어야 합니다.:

  • contents:read

공용 리소스만 요청되는 경우 인증 또는 앞서 언급한 권한 없이 이 엔드포인트를 사용할 수 있습니다.

"Get community profile metrics"에 대한 매개 변수

이름, Type, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
이름, Type, 설명
owner string Required

The account owner of the repository. The name is not case sensitive.

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

"Get community profile metrics"에 대한 HTTP 응답 상태 코드

상태 코드설명


"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" \


Status: 200
{ "health_percentage": 100, "description": "My first repository on GitHub!", "documentation": null, "files": { "code_of_conduct": { "name": "Contributor Covenant", "key": "contributor_covenant", "url": "", "html_url": "" }, "code_of_conduct_file": { "url": "", "html_url": "" }, "contributing": { "url": "", "html_url": "" }, "issue_template": { "url": "", "html_url": "" }, "pull_request_template": { "url": "", "html_url": "" }, "license": { "name": "MIT License", "key": "mit", "spdx_id": "MIT", "url": "", "html_url": "", "node_id": "MDc6TGljZW5zZW1pdA==" }, "readme": { "url": "", "html_url": "" } }, "updated_at": "2017-02-28T19:09:29Z", "content_reports_enabled": true }