{{< details >}}
- Tier: 基础版,专业版,旗舰版
- Offering: JihuLab.com,私有化部署
{{< /details >}}
使用此 API 来查看事件活动。事件可以包括广泛的操作,如加入项目、在议题上评论、推送更改到 MR 或关闭史诗。
有关活动保留限制的信息,请参见:
列出所有事件
列出当前已认证用户的所有事件。不会返回与史诗相关的事件。
先决条件:
- 您的访问令牌必须具有
read_user
或api
范围。
GET /events
参数:
参数 | 类型 | 必需 | 描述 |
---|---|---|---|
action |
string | 否 | 如果定义,则返回指定 操作类型 的事件。 |
target_type |
string | 否 | 如果定义,则返回指定 目标类型 的事件。 |
before |
date (ISO 8601) | 否 | 如果定义,则返回在指定日期之前创建的令牌。 |
after |
date (ISO 8601) | 否 | 如果定义,则返回在指定日期之后创建的令牌。 |
scope |
string | 否 | 包括用户项目中的所有事件。 |
sort |
string | 否 | 按创建日期排序结果的方向。可能的值:asc ,desc 。默认值:desc 。 |
请求示例:
curl --request GET \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/events?target_type=issue&action=created&after=2017-01-31&before=2017-03-01&scope=all"
响应示例:
[
{
"id": 1,
"title":null,
"project_id":1,
"action_name":"opened",
"target_id":160,
"target_iid":53,
"target_type":"Issue",
"author_id":25,
"target_title":"Qui natus eos odio tempore et quaerat consequuntur ducimus cupiditate quis.",
"created_at":"2017-02-09T10:43:19.667Z",
"author":{
"name":"User 3",
"username":"user3",
"id":25,
"state":"active",
"avatar_url":"http://www.gravatar.com/avatar/97d6d9441ff85fdc730e02a6068d267b?s=80\u0026d=identicon",
"web_url":"https://gitlab.example.com/user3"
},
"author_username":"user3",
"imported":false,
"imported_from": "none"
},
{
"id": 2,
"title":null,
"project_id":1,
"action_name":"opened",
"target_id":159,
"target_iid":14,
"target_type":"Issue",
"author_id":21,
"target_title":"Nostrum enim non et sed optio illo deleniti non.",
"created_at":"2017-02-09T10:43:19.426Z",
"author":{
"name":"Test User",
"username":"ted",
"id":21,
"state":"active",
"avatar_url":"http://www.gravatar.com/avatar/80fb888c9a48b9a3f87477214acaa63f?s=80\u0026d=identicon",
"web_url":"https://gitlab.example.com/ted"
},
"author_username":"ted",
"imported":false,
"imported_from": "none"
}
]
获取用户的贡献事件
获取指定用户的贡献事件。不会返回与史诗相关的事件。
先决条件:
- 您的访问令牌必须具有
read_user
或api
范围。
GET /users/:id/events
参数:
参数 | 类型 | 必需 | 描述 |
---|---|---|---|
id |
integer | 是 | 用户的 ID 或用户名。 |
action |
string | 否 | 如果定义,则返回指定 操作类型 的事件。 |
target_type |
string | 否 | 如果定义,则返回指定 目标类型 的事件。 |
before |
date (ISO 8601) | 否 | 如果定义,则返回在指定日期之前创建的令牌。 |
after |
date (ISO 8601) | 否 | 如果定义,则返回在指定日期之后创建的令牌。 |
sort |
string | 否 | 按创建日期排序结果的方向。可能的值:asc ,desc 。默认值:desc 。 |
page |
integer | 否 | 返回指定结果页。默认值:1 。 |
per_page |
integer | 否 | 每页结果数。默认值:20 。 |
请求示例:
curl --request GET \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/users/:id/events"
响应示例:
[
{
"id": 3,
"title": null,
"project_id": 15,
"action_name": "closed",
"target_id": 830,
"target_iid": 82,
"target_type": "Issue",
"author_id": 1,
"target_title": "Public project search field",
"author": {
"name": "Dmitriy Zaporozhets",
"username": "root",
"id": 1,
"state": "active",
"avatar_url": "http://localhost:3000/uploads/user/avatar/1/fox_avatar.png",
"web_url": "http://localhost:3000/root"
},
"author_username": "root",
"imported": false,
"imported_from": "none"
},
{
"id": 4,
"title": null,
"project_id": 15,
"action_name": "pushed",
"target_id": null,
"target_iid": null,
"target_type": null,
"author_id": 1,
"author": {
"name": "Dmitriy Zaporozhets",
"username": "root",
"id": 1,
"state": "active",
"avatar_url": "http://localhost:3000/uploads/user/avatar/1/fox_avatar.png",
"web_url": "http://localhost:3000/root"
},
"author_username": "john",
"imported": false,
"imported_from": "none",
"push_data": {
"commit_count": 1,
"action": "pushed",
"ref_type": "branch",
"commit_from": "50d4420237a9de7be1304607147aec22e4a14af7",
"commit_to": "c5feabde2d8cd023215af4d2ceeb7a64839fc428",
"ref": "main",
"commit_title": "Add simple search to projects in public area"
},
"target_title": null
},
{
"id": 5,
"title": null,
"project_id": 15,
"action_name": "closed",
"target_id": 840,
"target_iid": 11,
"target_type": "Issue",
"author_id": 1,
"target_title": "Finish & merge Code search PR",
"author": {
"name": "Dmitriy Zaporozhets",
"username": "root",
"id": 1,
"state": "active",
"avatar_url": "http://localhost:3000/uploads/user/avatar/1/fox_avatar.png",
"web_url": "http://localhost:3000/root"
},
"author_username": "root",
"imported": false,
"imported_from": "none"
},
{
"id": 7,
"title": null,
"project_id": 15,
"action_name": "commented on",
"target_id": 1312,
"target_iid": 61,
"target_type": "Note",
"author_id": 1,
"target_title": null,
"created_at": "2015-12-04T10:33:58.089Z",
"note": {
"id": 1312,
"body": "What an awesome day!",
"attachment": null,
"author": {
"name": "Dmitriy Zaporozhets",
"username": "root",
"id": 1,
"state": "active",
"avatar_url": "http://localhost:3000/uploads/user/avatar/1/fox_avatar.png",
"web_url": "http://localhost:3000/root"
},
"created_at": "2015-12-04T10:33:56.698Z",
"system": false,
"noteable_id": 377,
"noteable_type": "Issue"
},
"author": {
"name": "Dmitriy Zaporozhets",
"username": "root",
"id": 1,
"state": "active",
"avatar_url": "http://localhost:3000/uploads/user/avatar/1/fox_avatar.png",
"web_url": "http://localhost:3000/root"
},
"author_username": "root",
"imported": false,
"imported_from": "none"
}
]
列出项目的可见事件
列出指定项目的所有可见事件。
GET /projects/:project_id/events
参数:
参数 | 类型 | 必需 | 描述 |
---|---|---|---|
project_id |
integer/string | 是 | 项目的 ID 或 URL 编码路径。 |
action |
string | 否 | 如果定义,则返回指定 操作类型 的事件。 |
target_type |
string | 否 | 如果定义,则返回指定 目标类型 的事件。 |
before |
date (ISO 8601) | 否 | 如果定义,则返回在指定日期之前创建的令牌。 |
after |
date (ISO 8601) | 否 | 如果定义,则返回在指定日期之后创建的令牌。 |
sort |
string | 否 | 按创建日期排序结果的方向。可能的值:asc ,desc 。默认值:desc 。 |
请求示例:
curl --request GET \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/:project_id/events?target_type=issue&action=created&after=2017-01-31&before=2017-03-01"
响应示例:
[
{
"id": 8,
"title":null,
"project_id":1,
"action_name":"opened",
"target_id":160,
"target_iid":160,
"target_type":"Issue",
"author_id":25,
"target_title":"Qui natus eos odio tempore et quaerat consequuntur ducimus cupiditate quis.",
"created_at":"2017-02-09T10:43:19.667Z",
"author":{
"name":"User 3",
"username":"user3",
"id":25,
"state":"active",
"avatar_url":"http://www.gravatar.com/avatar/97d6d9441ff85fdc730e02a6068d267b?s=80\u0026d=identicon",
"web_url":"https://gitlab.example.com/user3"
},
"author_username":"user3",
"imported":false,
"imported_from": "none"
},
{
"id": 9,
"title":null,
"project_id":1,
"action_name":"opened",
"target_id":159,
"target_iid":159,
"target_type":"Issue",
"author_id":21,
"target_title":"Nostrum enim non et sed optio illo deleniti non.",
"created_at":"2017-02-09T10:43:19.426Z",
"author":{
"name":"Test User",
"username":"ted",
"id":21,
"state":"active",
"avatar_url":"http://www.gravatar.com/avatar/80fb888c9a48b9a3f87477214acaa63f?s=80\u0026d=identicon",
"web_url":"https://gitlab.example.com/ted"
},
"author_username":"ted",
"imported":false,
"imported_from": "none"
},
{
"id": 10,
"title": null,
"project_id": 1,
"action_name": "commented on",
"target_id": 1312,
"target_iid": 1312,
"target_type": "Note",
"author_id": 1,
"data": null,
"target_title": null,
"created_at": "2015-12-04T10:33:58.089Z",
"note": {
"id": 1312,
"body": "What an awesome day!",
"attachment": null,
"author": {
"name": "Dmitriy Zaporozhets",
"username": "root",
"id": 1,
"state": "active",
"avatar_url": "https://gitlab.example.com/uploads/user/avatar/1/fox_avatar.png",
"web_url": "https://gitlab.example.com/root"
},
"created_at": "2015-12-04T10:33:56.698Z",
"system": false,
"noteable_id": 377,
"noteable_type": "Issue",
"noteable_iid": 377
},
"author": {
"name": "Dmitriy Zaporozhets",
"username": "root",
"id": 1,
"state": "active",
"avatar_url": "https://gitlab.example.com/uploads/user/avatar/1/fox_avatar.png",
"web_url": "https://gitlab.example.com/root"
},
"author_username": "root",
"imported": false,
"imported_from": "none"
}
]
目标类型
{{< history >}}
- 在极狐GitLab 17.3 中增加了
epic
。
{{< /history >}}
您可以过滤结果以返回来自特定目标类型的事件。可能的值是:
-
epic
1 issue
merge_request
milestone
-
note
2 project
snippet
user
脚注: