Get community profile metrics

GET

/repos/{owner}/{repo}/community/profile

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
these four documents are present: README, CONTRIBUTING, LICENSE, and
CODE_OF_CONDUCT. For example, if all four documents are present, then
the health_percentage is 100. If only one is present, then the
health_percentage is 25.

content_reports_enabled is only returned for organization-owned repositories.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/repos///community/profile'

Response Example

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

Request

Path Params

owner

string

required

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

repo

string

required

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

Responses

🟢200Response

application/json

Body

Community Profile

content_reports_enabled

boolean

optional

Example:

true

description

string | null

required

Example:

My first repository on GitHub!

documentation

string | null

required

Example:

example.com

files

object

required

code_of_conduct

object (Code Of Conduct Simple) | null

required

Code of Conduct Simple

code_of_conduct_file

object (Community Health File) | null

required

contributing

object (Community Health File) | null

required

issue_template

object (Community Health File) | null

required

license

object (License Simple) | null

required

License Simple

pull_request_template

object (Community Health File) | null

required

readme

object (Community Health File) | null

required

health_percentage

integer

required

Example:

100

updated_at

string <date-time> | null

required

Example:

2017-02-28T19:09:29.000Z

Modified at 2023-08-15 02:59:29

List commit statuses for a reference

Compare two commits