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

禁止

“获取代码库克隆”的代码示例

请求示例

获取/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

禁止

“获取顶级推荐路径”的代码示例

请求示例

获取/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

禁止

“获取顶级推荐来源”的代码示例

请求示例

获取/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

禁止

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

请求示例

获取/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 } ] }