REST API 现在已版本化。 有关更多信息，请参阅 "关于 API 版本控制”。

仓库流量的 REST API 端点

使用 REST API 检索仓库图表中提供的信息。

关于仓库流量

您可以使用这些端点检索仓库图表中提供的信息，适用于您拥有写入权限的仓库。有关更多信息，请参阅 "查看仓库流量”。

获取仓库克隆

获取过去 14 天的总克隆数以及每天或每周的细分数据。时间戳与当天或当周开始的 UTC 午夜对齐。一周从星期一开始。

用于“获取仓库克隆”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • "管理" 仓库权限 (读取)

"获取仓库克隆" 参数

头部
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
owner 字符串 必需

仓库的账户所有者。名称不区分大小写。

repo 字符串 必需

仓库名称，不含 .git 扩展名。名称不区分大小写。

查询参数
per 字符串

显示结果的时间范围。

默认: day

可以是以下之一: day, week

"获取仓库克隆" 的 HTTP 响应状态码

状态码描述
200

OK

403

禁止

"获取仓库克隆" 的代码示例

请求示例

get/repos/{owner}/{repo}/traffic/clones
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/traffic/clones

响应

状态: 200
{ "count": 173, "uniques": 128, "clones": [ { "timestamp": "2016-10-10T00:00:00Z", "count": 2, "uniques": 1 }, { "timestamp": "2016-10-11T00:00:00Z", "count": 17, "uniques": 16 }, { "timestamp": "2016-10-12T00:00:00Z", "count": 21, "uniques": 15 }, { "timestamp": "2016-10-13T00:00:00Z", "count": 8, "uniques": 7 }, { "timestamp": "2016-10-14T00:00:00Z", "count": 5, "uniques": 5 }, { "timestamp": "2016-10-15T00:00:00Z", "count": 2, "uniques": 2 }, { "timestamp": "2016-10-16T00:00:00Z", "count": 8, "uniques": 7 }, { "timestamp": "2016-10-17T00:00:00Z", "count": 26, "uniques": 15 }, { "timestamp": "2016-10-18T00:00:00Z", "count": 19, "uniques": 17 }, { "timestamp": "2016-10-19T00:00:00Z", "count": 19, "uniques": 14 }, { "timestamp": "2016-10-20T00:00:00Z", "count": 19, "uniques": 15 }, { "timestamp": "2016-10-21T00:00:00Z", "count": 9, "uniques": 7 }, { "timestamp": "2016-10-22T00:00:00Z", "count": 5, "uniques": 5 }, { "timestamp": "2016-10-23T00:00:00Z", "count": 6, "uniques": 5 }, { "timestamp": "2016-10-24T00:00:00Z", "count": 7, "uniques": 5 } ] }

获取热门推荐路径

获取过去 14 天内排名前 10 的热门内容。

“获取热门推荐路径”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • "管理" 仓库权限 (读取)

“获取热门推荐路径”的参数

头部
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
owner 字符串 必需

仓库的账户所有者。名称不区分大小写。

repo 字符串 必需

仓库名称，不含 .git 扩展名。名称不区分大小写。

“获取热门推荐路径”的 HTTP 响应状态码

状态码描述
200

OK

403

禁止

“获取热门推荐路径”的代码示例

请求示例

get/repos/{owner}/{repo}/traffic/popular/paths
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/traffic/popular/paths

响应

状态: 200
[ { "path": "/github/hubot", "title": "github/hubot: A customizable life embetterment robot.", "count": 3542, "uniques": 2225 }, { "path": "/github/hubot/blob/master/docs/scripting.md", "title": "hubot/scripting.md at master · github/hubot · GitHub", "count": 1707, "uniques": 804 }, { "path": "/github/hubot/tree/master/docs", "title": "hubot/docs at master · github/hubot · GitHub", "count": 685, "uniques": 435 }, { "path": "/github/hubot/tree/master/src", "title": "hubot/src at master · github/hubot · GitHub", "count": 577, "uniques": 347 }, { "path": "/github/hubot/blob/master/docs/index.md", "title": "hubot/index.md at master · github/hubot · GitHub", "count": 379, "uniques": 259 }, { "path": "/github/hubot/blob/master/docs/adapters.md", "title": "hubot/adapters.md at master · github/hubot · GitHub", "count": 354, "uniques": 201 }, { "path": "/github/hubot/tree/master/examples", "title": "hubot/examples at master · github/hubot · GitHub", "count": 340, "uniques": 260 }, { "path": "/github/hubot/blob/master/docs/deploying/heroku.md", "title": "hubot/heroku.md at master · github/hubot · GitHub", "count": 324, "uniques": 217 }, { "path": "/github/hubot/blob/master/src/robot.coffee", "title": "hubot/robot.coffee at master · github/hubot · GitHub", "count": 293, "uniques": 191 }, { "path": "/github/hubot/blob/master/LICENSE.md", "title": "hubot/LICENSE.md at master · github/hubot · GitHub", "count": 281, "uniques": 222 } ]

获取热门推荐来源

获取过去 14 天内排名前 10 的推荐来源。

“获取热门推荐来源”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • "管理" 仓库权限 (读取)

“获取热门推荐来源”的参数

头部
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
owner 字符串 必需

仓库的账户所有者。名称不区分大小写。

repo 字符串 必需

仓库名称，不含 .git 扩展名。名称不区分大小写。

“获取热门推荐来源”的 HTTP 响应状态码

状态码描述
200

OK

403

禁止

“获取热门推荐来源”的代码示例

请求示例

get/repos/{owner}/{repo}/traffic/popular/referrers
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/traffic/popular/referrers

响应

状态: 200
[ { "referrer": "Google", "count": 4, "uniques": 3 }, { "referrer": "stackoverflow.com", "count": 2, "uniques": 2 }, { "referrer": "eggsonbread.com", "count": 1, "uniques": 1 }, { "referrer": "yandex.ru", "count": 1, "uniques": 1 } ]

获取页面浏览量

获取过去 14 天的总浏览量，并按天或周进行细分。时间戳与当天或当周开始时间的 UTC 午夜对齐。一周从周一算起。

获取页面浏览量的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • "管理" 仓库权限 (读取)

获取页面浏览量的参数

头部
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
owner 字符串 必需

仓库的账户所有者。名称不区分大小写。

repo 字符串 必需

仓库名称，不含 .git 扩展名。名称不区分大小写。

查询参数
per 字符串

显示结果的时间范围。

默认: day

可以是以下之一: day, week

获取页面浏览量的 HTTP 响应状态码

状态码描述
200

OK

403

禁止

获取页面浏览量的代码示例

请求示例

get/repos/{owner}/{repo}/traffic/views
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/traffic/views

响应

状态: 200
{ "count": 14850, "uniques": 3782, "views": [ { "timestamp": "2016-10-10T00:00:00Z", "count": 440, "uniques": 143 }, { "timestamp": "2016-10-11T00:00:00Z", "count": 1308, "uniques": 414 }, { "timestamp": "2016-10-12T00:00:00Z", "count": 1486, "uniques": 452 }, { "timestamp": "2016-10-13T00:00:00Z", "count": 1170, "uniques": 401 }, { "timestamp": "2016-10-14T00:00:00Z", "count": 868, "uniques": 266 }, { "timestamp": "2016-10-15T00:00:00Z", "count": 495, "uniques": 157 }, { "timestamp": "2016-10-16T00:00:00Z", "count": 524, "uniques": 175 }, { "timestamp": "2016-10-17T00:00:00Z", "count": 1263, "uniques": 412 }, { "timestamp": "2016-10-18T00:00:00Z", "count": 1402, "uniques": 417 }, { "timestamp": "2016-10-19T00:00:00Z", "count": 1394, "uniques": 424 }, { "timestamp": "2016-10-20T00:00:00Z", "count": 1492, "uniques": 448 }, { "timestamp": "2016-10-21T00:00:00Z", "count": 1153, "uniques": 332 }, { "timestamp": "2016-10-22T00:00:00Z", "count": 566, "uniques": 168 }, { "timestamp": "2016-10-23T00:00:00Z", "count": 675, "uniques": 184 }, { "timestamp": "2016-10-24T00:00:00Z", "count": 614, "uniques": 237 } ] }