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": 75,
    "code_of_conduct": "Contributor Covenant",
    "has_contributing": false,
    "license": "MIT License",
    "has_readme": true,
    "updated_at": "2016-12-05T11:46:11-08:00"
  }
]