此版本的 GitHub Enterprise 已停止服务 2022-10-12. 即使针对重大安全问题，也不会发布补丁。为了获得更好的性能、更高的安全性和新功能，请升级到最新版本的 GitHub Enterprise。如需升级帮助，请联系 GitHub Enterprise 支持。

We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the new Branches, Collaborators, Commits, Deploy Keys, Deployments, GitHub Pages, Releases, Metrics, Webhooks REST API pages.

存储库统计信息

存储库统计信息 API 允许� 获取 GitHub Enterprise Server 用于可视化不同类型存储库活动的数据。

关于存储库统计信息 API

存储库统计信息 API 允许� 获取 GitHub Enterprise Server 用于可视化不同类型存储库活动的数据。

谈一谈缓存

计算存储库统计信息是一项昂贵的操作，所以我们尽可能返回缓存的数据。如果� 查询存储库的统计信息时数据尚未缓存，� 将会收到 202 响应；同时触发后台作业以开始编译这些统计信息。稍等片刻，待作业完成，然后再次提交请求。如果作业已完成，该请求将返回 200 响应，响应正文中包含统计信息。

仓库统计信息由仓库默认分支的 SHA 缓存；推送到默认分支将重置统计信息缓存。

统计排除某些类型的提交

API 公开的统计信息与不同存储库图显示的统计信息匹配。

总结：

所有统计信息都排除合并提交。
参与者统计信息还排除空提交。

Get the weekly commit activity

使用 GitHub Apps

Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.

HTTP 响应状态代� �

状态代� �	说明
`200`	Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
`202`	Accepted
`204`	A header with no content is returned.

代� �示例

get/repos/{owner}/{repo}/stats/code_frequency

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/stats/code_frequency

Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

Status: 200

[
  [
    1302998400,
    1124,
    -435
  ]
]

Get the last year of commit activity

使用 GitHub Apps

Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.

HTTP 响应状态代� �

状态代� �	说明
`200`	OK
`202`	Accepted
`204`	A header with no content is returned.

代� �示例

get/repos/{owner}/{repo}/stats/commit_activity

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/stats/commit_activity

Response

Status: 200

[
  {
    "days": [
      0,
      3,
      26,
      20,
      39,
      1,
      0
    ],
    "total": 89,
    "week": 1336280400
  }
]

Get all contributor commit activity

使用 GitHub Apps

Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:

w - Start of the week, given as a Unix timestamp.
a - Number of additions
d - Number of deletions
c - Number of commits

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.

HTTP 响应状态代� �

状态代� �	说明
`200`	OK
`202`	Accepted
`204`	A header with no content is returned.

代� �示例

get/repos/{owner}/{repo}/stats/contributors

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/stats/contributors

Response

Status: 200

[
  {
    "author": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "total": 135,
    "weeks": [
      {
        "w": 1367712000,
        "a": 6898,
        "d": 77,
        "c": 10
      }
    ]
  }
]

Get the weekly commit count

使用 GitHub Apps

Returns the total commit counts for the owner and total commit counts in all. all is everyone combined, including the owner in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract owner from all.

The array order is oldest week (index 0) to most recent week.

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.

HTTP 响应状态代� �

状态代� �	说明
`200`	The array order is oldest week (index 0) to most recent week.
`404`	Resource not found

代� �示例

get/repos/{owner}/{repo}/stats/participation

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/stats/participation

The array order is oldest week (index 0) to most recent week.

Status: 200

Get the hourly commit count for each day

使用 GitHub Apps

Each array contains the day number, hour number, and number of commits:

0-6: Sunday - Saturday
0-23: Hour of day
Number of commits

For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.

HTTP 响应状态代� �

状态代� �	说明
`200`	For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
`204`	A header with no content is returned.

代� �示例

get/repos/{owner}/{repo}/stats/punch_card

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/stats/punch_card

For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

Status: 200

存储库统计信息

关于存储库统计信息 API

谈一谈缓存

统计排除某些类型的提交

Get the weekly commit activity

Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

Get the last year of commit activity

Response

Get all contributor commit activity

Response

Get the weekly commit count

The array order is oldest week (index 0) to most recent week.

Get the hourly commit count for each day

For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.