Skip to main content
The REST API is now versioned. For more information, see "About API versioning."

REST API endpoints for community metrics

Use the REST API to retrieve information about your community profile.

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.

Fine-grained access tokens for "Get community profile metrics"

This endpoint works with the following token types:

The token must have the following permission set:

  • contents:read

This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

Parameters for "Get community profile metrics"

Name, Type, Description
accept string

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

Path parameters
Name, Type, Description
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.

HTTP response status codes for "Get community profile metrics"

Status codeDescription


Code samples for "Get community profile metrics"

Request example

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 }