Sign in

v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,4581,08113.3 MB
repos

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/repos/{owner}/{repo}/community/profile

Path parameters

ownerstring required

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

repostring required

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

Response

Response

health_percentageinteger required
descriptionstring nullable required
documentationstring nullable required
updated_atstring date-time nullable required
content_reports_enabledboolean

Example response

{
  "health_percentage": 100,
  "description": "My first repository on GitHub!",
  "documentation": "example.com",
  "files": {
    "code_of_conduct": {
      "url": "https://api.github.com/repos/github/docs/community/code_of_conduct",
      "key": "citizen_code_of_conduct",
      "name": "Citizen Code of Conduct",
      "html_url": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md"
    },
    "license": {
      "key": "mit",
      "name": "MIT License",
      "url": "https://api.github.com/licenses/mit",
      "spdx_id": "MIT",
      "node_id": "MDc6TGljZW5zZW1pdA=="
    }
  },
  "updated_at": "2017-02-28T19:09:29Z",
  "content_reports_enabled": true
}