イシュー統計API
イシュー統計APIへのAPIコールはすべて認証されなければなりません。
ユーザーがプロジェクトのメンバーではなく、プロジェクトが非公開である場合、そのプロジェクトに対するGET
リクエストは404
ステータスコードになります。
イシュー統計の取得
認証済みユーザがアクセスできるすべてのイシューについて、イシュー数の統計を取得します。デフォルトでは、現在のユーザが作成したイシューのみを返します。すべてのイシューを取得するには、パラメータscope=all
を使用してください。
GET /issues_statistics
GET /issues_statistics?labels=foo
GET /issues_statistics?labels=foo,bar
GET /issues_statistics?labels=foo,bar&state=opened
GET /issues_statistics?milestone=1.0.0
GET /issues_statistics?milestone=1.0.0&state=opened
GET /issues_statistics?iids[]=42&iids[]=43
GET /issues_statistics?author_id=5
GET /issues_statistics?assignee_id=5
GET /issues_statistics?my_reaction_emoji=star
GET /issues_statistics?search=foo&in=title
GET /issues_statistics?confidential=true
属性 | 種類 | 必須 | 説明 |
---|---|---|---|
labels | 文字列です。 | いいえ | ラベル名のカンマ区切りリスト。None 、ラベルがないすべてのイシューをリストします。Any 、少なくとも1つのラベルがあるすべてのイシューをリストします。 |
milestone | 文字列です。 | いいえ | マイルストーンのタイトルです。None 、マイルストーンのないすべてのイシューがリストされます。Any 、マイルストーンが割り当てられているすべてのイシューがリストされます。 |
scope | 文字列です。 | いいえ | 指定されたスコープのイシューを返します:created_by_me assigned_to_me またはall 。デフォルトはcreated_by_me
|
author_id | 整数。 | いいえ | 指定されたユーザーid によって作成されたイシューを返します。author_username と排他的です。scope=all またはscope=assigned_to_me と組み合わせます。 |
author_username | 文字列です。 | いいえ | 指定されたusername によって作成されたイシューを返します。.NETと似てauthor_id いますが、互いに排他的 author_id です。 |
assignee_id | 整数。 | いいえ | 指定されたユーザーid に割り当てられたイシューを返します。assignee_username と排他的です。None は未割り当てのイシューを返します。Any は担当者を持つイシューを返します。 |
assignee_username | 文字列配列 | いいえ | 与えられたusername に割り当てられたイシューを返します。に似てassignee_id おり、相互に排他的 assignee_id です。 GitLab CEassignee_username 配列には単一の値のみを含める必要があり、そうでない場合は無効なパラメータエラーが返されます。 |
epic_id
| 整数。 | いいえ |
None はエピックに関連しないイシューを返します。Any はエピックに関連するイシューを返します。(GitLab 13.6 で導入されました)
|
my_reaction_emoji | 文字列です。 | いいえ |
emoji None は、リアクションが与えられていないイシューを返します。Any は、少なくとも1つのリアクションが与えられたイシューを返します。 |
iids[] | 整数配列。 | いいえ | 与えられたiid
|
search | 文字列です。 | いいえ |
title 、イシューを検索します。description
|
in | 文字列です。 | いいえ |
search 属性のスコープを変更します。title ,description , またはカンマで連結した文字列。デフォルトはtitle,description
|
created_after | datetime | いいえ | 指定された時刻以降に作成されたイシューを返します。ISO 8601 フォーマット (2019-03-15T08:00:00Z ) で指定します。 |
created_before | datetime | いいえ | 指定された時刻以前に作成されたイシューを返します。ISO 8601フォーマット (2019-03-15T08:00:00Z ) で期待されるもの |
updated_after | datetime | いいえ | 指定された時刻以降に更新されたイシューを返します。ISO 8601 フォーマット (2019-03-15T08:00:00Z ) で期待されるもの |
updated_before | datetime | いいえ | 指定された時刻以前に更新されたイシューを返します。ISO 8601 フォーマット (2019-03-15T08:00:00Z ) で期待されるもの |
confidential | boolean | いいえ | 機密または公開イシューをフィルタリングします。 |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/issues_statistics"
応答例
{
"statistics": {
"counts": {
"all": 20,
"closed": 5,
"opened": 15
}
}
}
グループissue統計の取得
指定されたグループのイシュー数の統計を取得します。
GET /groups/:id/issues_statistics
GET /groups/:id/issues_statistics?labels=foo
GET /groups/:id/issues_statistics?labels=foo,bar
GET /groups/:id/issues_statistics?labels=foo,bar&state=opened
GET /groups/:id/issues_statistics?milestone=1.0.0
GET /groups/:id/issues_statistics?milestone=1.0.0&state=opened
GET /groups/:id/issues_statistics?iids[]=42&iids[]=43
GET /groups/:id/issues_statistics?search=issue+title+or+description
GET /groups/:id/issues_statistics?author_id=5
GET /groups/:id/issues_statistics?assignee_id=5
GET /groups/:id/issues_statistics?my_reaction_emoji=star
GET /groups/:id/issues_statistics?confidential=true
属性 | 種類 | 必須 | 説明 |
---|---|---|---|
id | 整数/文字列 | yes | 認証ユーザーが所有するグループのIDまたはURLエンコードされたパス |
labels | 文字列です。 | いいえ | ラベル名のカンマ区切りリスト。None 、ラベルがないすべてのイシューをリストします。Any 、少なくとも1つのラベルがあるすべてのイシューをリストします。 |
iids[] | 整数配列。 | いいえ | 与えられたiid
|
milestone | 文字列です。 | いいえ | マイルストーンのタイトルです。None 、マイルストーンのないすべてのイシューがリストされます。Any 、マイルストーンが割り当てられているすべてのイシューがリストされます。 |
scope | 文字列です。 | いいえ | 指定されたスコープのイシューを返します:created_by_me assigned_to_me またはall 。 |
author_id | 整数。 | いいえ | 指定されたユーザーid によって作成されたイシューを返します。author_username と排他的です。scope=all またはscope=assigned_to_me と組み合わせます。 |
author_username | 文字列です。 | いいえ | 指定されたusername によって作成されたイシューを返します。.NETと似てauthor_id いますが、互いに排他的 author_id です。 |
assignee_id | 整数。 | いいえ | 指定されたユーザーid に割り当てられたイシューを返します。assignee_username と排他的です。None は未割り当てのイシューを返します。Any は担当者を持つイシューを返します。 |
assignee_username | 文字列配列 | いいえ | 与えられたusername に割り当てられたイシューを返します。に似てassignee_id おり、相互に排他的 assignee_id です。 GitLab CEassignee_username 配列には単一の値のみを含める必要があり、そうでない場合は無効なパラメータエラーが返されます。 |
my_reaction_emoji | 文字列です。 | いいえ |
emoji None は、リアクションが与えられていないイシューを返します。Any は、少なくとも1つのリアクションが与えられたイシューを返します。 |
search | 文字列です。 | いいえ | グループのイシューをtitle と照らし合わせて検索します。description
|
created_after | datetime | いいえ | 指定された時刻以降に作成されたイシューを返します。ISO 8601 フォーマット (2019-03-15T08:00:00Z ) で指定します。 |
created_before | datetime | いいえ | 指定された時刻以前に作成されたイシューを返します。ISO 8601フォーマット (2019-03-15T08:00:00Z ) で期待されるもの |
updated_after | datetime | いいえ | 指定された時刻以降に更新されたイシューを返します。ISO 8601 フォーマット (2019-03-15T08:00:00Z ) で期待されるもの |
updated_before | datetime | いいえ | 指定された時刻以前に更新されたイシューを返します。ISO 8601 フォーマット (2019-03-15T08:00:00Z ) で期待されるもの |
confidential | boolean | いいえ | 機密または公開イシューをフィルタリングします。 |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/4/issues_statistics"
応答例
{
"statistics": {
"counts": {
"all": 20,
"closed": 5,
"opened": 15
}
}
}
プロジェクトのイシュー統計の取得
指定したプロジェクトのイシュー数の統計を取得します。
GET /projects/:id/issues_statistics
GET /projects/:id/issues_statistics?labels=foo
GET /projects/:id/issues_statistics?labels=foo,bar
GET /projects/:id/issues_statistics?labels=foo,bar&state=opened
GET /projects/:id/issues_statistics?milestone=1.0.0
GET /projects/:id/issues_statistics?milestone=1.0.0&state=opened
GET /projects/:id/issues_statistics?iids[]=42&iids[]=43
GET /projects/:id/issues_statistics?search=issue+title+or+description
GET /projects/:id/issues_statistics?author_id=5
GET /projects/:id/issues_statistics?assignee_id=5
GET /projects/:id/issues_statistics?my_reaction_emoji=star
GET /projects/:id/issues_statistics?confidential=true
属性 | 種類 | 必須 | 説明 |
---|---|---|---|
id | 整数/文字列 | yes | 認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス |
iids[] | 整数配列。 | いいえ | 指定されたマイルストーンのみを返します。iid
|
labels | 文字列です。 | いいえ | ラベル名のカンマ区切りリスト。None 、ラベルがないすべてのイシューをリストします。Any 、少なくとも1つのラベルがあるすべてのイシューをリストします。 |
milestone | 文字列です。 | いいえ | マイルストーンのタイトルです。None 、マイルストーンのないすべてのイシューがリストされます。Any 、マイルストーンが割り当てられているすべてのイシューがリストされます。 |
scope | 文字列です。 | いいえ | 指定されたスコープのイシューを返します:created_by_me assigned_to_me またはall 。 |
author_id | 整数。 | いいえ | 指定されたユーザーid によって作成されたイシューを返します。author_username と排他的です。scope=all またはscope=assigned_to_me と組み合わせます。 |
author_username | 文字列です。 | いいえ | 指定されたusername によって作成されたイシューを返します。.NETと似てauthor_id いますが、互いに排他的 author_id です。 |
assignee_id | 整数。 | いいえ | 指定されたユーザーid に割り当てられたイシューを返します。assignee_username と排他的です。None は未割り当てのイシューを返します。Any は担当者を持つイシューを返します。 |
assignee_username | 文字列配列 | いいえ | 与えられたusername に割り当てられたイシューを返します。に似てassignee_id おり、相互に排他的 assignee_id です。 GitLab CEassignee_username 配列には単一の値のみを含める必要があり、そうでない場合は無効なパラメータエラーが返されます。 |
my_reaction_emoji | 文字列です。 | いいえ |
emoji None は、リアクションが与えられていないイシューを返します。Any は、少なくとも1つのリアクションが与えられたイシューを返します。 |
search | 文字列です。 | いいえ | プロジェクトのイシューをtitle と照らし合わせて検索します。description
|
created_after | datetime | いいえ | 指定された時刻以降に作成されたイシューを返します。ISO 8601 フォーマット (2019-03-15T08:00:00Z ) で指定します。 |
created_before | datetime | いいえ | 指定された時刻以前に作成されたイシューを返します。ISO 8601フォーマット (2019-03-15T08:00:00Z ) で期待されるもの |
updated_after | datetime | いいえ | 指定された時刻以降に更新されたイシューを返します。ISO 8601 フォーマット (2019-03-15T08:00:00Z ) で期待されるもの |
updated_before | datetime | いいえ | 指定された時刻以前に更新されたイシューを返します。ISO 8601 フォーマット (2019-03-15T08:00:00Z ) で期待されるもの |
confidential | boolean | いいえ | 機密または公開イシューをフィルタリングします。 |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/4/issues_statistics"
応答例
{
"statistics": {
"counts": {
"all": 20,
"closed": 5,
"opened": 15
}
}
}