Community Health

We're currently offering a preview of the Community Health API.

To access the API during the preview period, you must provide a custom media type in the Accept header:

application/vnd.github.black-panther-preview+json

Retrieve community health metrics

GET /repositories/:repo_id/community/profile

This endpoint will return all community health metrics, including an overall health score, detected code of conduct, detected license, and the presence of README and CONTRIBUTING files.

Response

Status: 200 OK
[
  {
    "health_percentage": 100,
    "files": {
      "code_of_conduct": {
        "name": "Contributor Covenant",
        "key": "contributor_covenant",
        "url": null,
        "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"
      },
      "license": {
        "name": "MIT License",
        "key": "mit",
        "url": "https://api.github.com/licenses/mit",
        "html_url": "https://github.com/octocat/Hello-World/blob/master/LICENSE"
      },
      "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"
  }
]