イシュー統計API
issues_statisticsへの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 配列には単一の値のみを含める必要があります。そうでない場合は無効なパラメータエラーが返されます。
|
my_reaction_emoji
| 列 | いいえ |
emoji None は、リアクションが与えられていないイシューを返します。 は、少なくとも1つのリアクションが与えられたイシューを返します。Any
|
iids[]
| 整数配列 | いいえ | 与えられたiid
|
search
| 列 | いいえ |
title 、イシューを検索します。description
|
in
| 列 | いいえ |
search 属性のスコープを変更します。title 、description 、またはそれらをカンマでつなげた文字列。デフォルトはtitle,description
|
created_after
| 日時 | いいえ | 指定された時刻以降に作成されたイシューを返します。 |
created_before
| 日時 | いいえ | 指定された時刻以前に作成されたイシューを返します。 |
updated_after
| 日時 | いいえ | 指定時刻以降に更新されたイシューを返します。 |
updated_before
| 日時 | いいえ | 指定された時刻までに更新されたイシューを返します。 |
confidential
| ブーリアン | いいえ | 機密または公開イシューをフィルタリングします。 |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/issues_statistics"
回答例
{
"statistics": {
"counts": {
"all": 20,
"closed": 5,
"opened": 15
}
}
}
グループのイシュー統計の取得
指定されたグループのイシュー数の統計を取得します。
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
| 整数/文字列 | はい | 認証されたユーザーが所有するグループの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 は、リアクションが与えられていないイシューを返します。 は、少なくとも1つのリアクションが与えられたイシューを返します。Any
|
search
| 列 | いいえ | グループのイシューをtitle と照らし合わせて検索します。description
|
created_after
| 日時 | いいえ | 指定された時刻以降に作成されたイシューを返します。 |
created_before
| 日時 | いいえ | 指定された時刻以前に作成されたイシューを返します。 |
updated_after
| 日時 | いいえ | 指定時刻以降に更新されたイシューを返します。 |
updated_before
| 日時 | いいえ | 指定された時刻までに更新されたイシューを返します。 |
confidential
| ブーリアン | いいえ | 機密または公開イシューをフィルタリングします。 |
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
| 整数/文字列 | はい | 認証されたユーザーが所有するプロジェクトの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 は、リアクションが与えられていないイシューを返します。 は、少なくとも1つのリアクションが与えられたイシューを返します。Any
|
search
| 列 | いいえ | プロジェクトのイシューをtitle と照らし合わせて検索します。description
|
created_after
| 日時 | いいえ | 指定された時刻以降に作成されたイシューを返します。 |
created_before
| 日時 | いいえ | 指定された時刻以前に作成されたイシューを返します。 |
updated_after
| 日時 | いいえ | 指定時刻以降に更新されたイシューを返します。 |
updated_before
| 日時 | いいえ | 指定された時刻までに更新されたイシューを返します。 |
confidential
| ブーリアン | いいえ | 機密または公開イシューをフィルタリングします。 |
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
}
}
}