イベントAPI

フィルタパラメータ

アクション

action パラメータで使用可能なタイプについては、ユーザー貢献イベントを参照してください。これらのオプションは小文字です。

ターゲットの種類

target_type パラメータで使用可能なターゲットタイプは以下の通りです：

  • issue
  • milestone
  • merge_request
  • note
  • project
  • snippet
  • user

これらのオプションは小文字です。エピックに関連するイベントは、API を使用して利用できません。

日付のフォーマット

before およびafter パラメータの日付は、以下のフォーマットで指定してください：

YYYY-MM-DD

イベント期間制限

GitLabはパフォーマンス上の理由から、3年以上前のイベントをイベントテーブルから削除します。

現在認証されているユーザーのイベント一覧

認証済みユーザーのイベント一覧を取得します。スコープread_user あるいはapi が必要です。エピックに関連するイベントは API を使用して取得できません。

GET /events

パラメータを指定します：

属性種類必須説明
action文字列です。いいえ特定のアクションタイプのイベントのみを含めます。
target_type文字列です。いいえ特定のターゲット・タイプのイベントのみを含めます。
before期日いいえ特定の日付より前に作成されたイベントのみを含めます。日付のフォーマット方法を表示します。
after期日いいえ特定の日付以降に作成されたイベントのみを含めます。日付のフォーマット方法を表示します。
scope文字列です。いいえユーザーのプロジェクト全体のすべてのイベントを含めます。
sort文字列です。いいえ asc またはdesc のイベントをcreated_atでソートします。デフォルトはdescです。

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "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_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"
  },
  {
    "id": 2,
    "title":null,
    "project_id":1,
    "action_name":"opened",
    "target_id":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"
  }
]

ユーザー貢献イベントの取得

指定したユーザーの貢献イベントを、新しい順に取得します。スコープread_user あるいはapi が必要です。エピックに関連するイベントは API を使用して取得できません。

GET /users/:id/events

パラメータを指定します：

属性種類必須説明
id整数。yesユーザーのIDまたはユーザー名
action文字列です。いいえ特定のアクションタイプのイベントのみを含めます。
target_type文字列です。いいえ特定のターゲット・タイプのイベントのみを含めます。
before期日いいえ特定の日付より前に作成されたイベントのみを含めます。日付のフォーマット方法を表示します。
after期日いいえ特定の日付以降に作成されたイベントのみを含めます。日付のフォーマット方法を表示します。
sort文字列です。いいえ asc またはdesc のイベントをcreated_atでソートします。デフォルトはdescです。
page整数。いいえ返す結果のページ。デフォルトは1です。
per_page整数。いいえページあたりの結果数。デフォルトは20です。
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/:id/events"

応答例

[
  {
    "id": 3,
    "title": null,
    "project_id": 15,
    "action_name": "closed",
    "target_id": 830,
    "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"
  },
  {
    "id": 4,
    "title": null,
    "project_id": 15,
    "action_name": "pushed",
    "target_id": 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",
    "push_data": {
      "commit_count": 1,
      "action": "pushed",
      "ref_type": "branch",
      "commit_from": "50d4420237a9de7be1304607147aec22e4a14af7",
      "commit_to": "c5feabde2d8cd023215af4d2ceeb7a64839fc428",
      "ref": "master",
      "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_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"
  },
  {
    "id": 7,
    "title": null,
    "project_id": 15,
    "action_name": "commented on",
    "target_id": 1312,
    "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"
  }
]

プロジェクトの可視イベントをリストアップします。

note
このエンドポイントは他のエンドポイントよりも長く存在しています。以前はProjects API pagesにドキュメントがありました。

特定のプロジェクトの可視イベントのリストを取得します。

GET /projects/:project_id/events

パラメータを指定します：

属性種類必須説明
project_id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス
action文字列です。いいえ特定のアクションタイプのイベントのみを含めます。
target_type文字列です。いいえ特定のターゲット・タイプのイベントのみを含めます。
before期日いいえ特定の日付より前に作成されたイベントのみを含めます。日付のフォーマット方法を表示します。
after期日いいえ特定の日付以降に作成されたイベントのみを含めます。日付のフォーマット方法を表示します。
sort文字列です。いいえ asc またはdesc のイベントをcreated_atでソートします。デフォルトはdescです。

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "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"
  },
  {
    "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"
  },
  {
    "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"
  }
]