Help us learn about your current experience with the documentation. Take the survey.

Issues 统计 API

Tier: Free, Premium, Ultimate
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

对 issues 统计 API 的每次调用都必须经过身份验证。

如果用户不是项目的成员，且项目是私有的，对该项目的 GET 请求将返回 404 状态码。

获取 issues 统计

获取认证用户有权访问的所有 issues 的计数统计。默认情况下，仅返回当前用户创建的 issues。要获取所有 issues，请使用参数 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`	string	否	标签名称的逗号分隔列表，issues 必须具有所有标签才会被返回。`None` 列出所有没有标签的 issues。`Any` 列出至少有一个标签的所有 issues。
`milestone`	string	否	里程碑标题。`None` 列出所有没有里程碑的 issues。`Any` 列出所有已分配里程碑的 issues。
`scope`	string	否	返回给定范围的 issues：`created_by_me`、`assigned_to_me` 或 `all`。默认为 `created_by_me`
`author_id`	integer	否	返回由给定用户 `id` 创建的 issues。与 `author_username` 互斥。与 `scope=all` 或 `scope=assigned_to_me` 结合使用。
`author_username`	string	否	返回由给定 `username` 创建的 issues。与 `author_id` 类似，且与 `author_id` 互斥。
`assignee_id`	integer	否	返回分配给给定用户 `id` 的 issues。与 `assignee_username` 互斥。`None` 返回未分配的 issues。`Any` 返回有受理人的 issues。
`assignee_username`	string array	否	返回分配给给定 `username` 的 issues。与 `assignee_id` 类似，且与 `assignee_id` 互斥。在 GitLab CE 中，`assignee_username` 数组应仅包含单个值，否则会返回无效参数错误。
`epic_id`	integer	否	返回与给定 epic ID 关联的 issues。`None` 返回未与 epic 关联的 issues。`Any` 返回与 epic 关联的 issues。仅限 Premium 和 Ultimate 版本。
`my_reaction_emoji`	string	否	返回认证用户通过给定 `emoji` 表态的 issues。`None` 返回未表态的 issues。`Any` 返回至少有一个表态的 issues。
`iids[]`	integer array	否	仅返回具有给定 `iid` 的 issues
`search`	string	否	根据其 `title` 和 `description` 搜索 issues
`in`	string	否	修改 `search` 属性的范围。`title`、`description` 或用逗号连接它们的字符串。默认为 `title,description`
`created_after`	datetime	否	返回在给定时间或之后创建的 issues。期望为 ISO 8601 格式 (`2019-03-15T08:00:00Z`)
`created_before`	datetime	否	返回在给定时间或之前创建的 issues。期望为 ISO 8601 格式 (`2019-03-15T08:00:00Z`)
`updated_after`	datetime	否	返回在给定时间或之后更新的 issues。期望为 ISO 8601 格式 (`2019-03-15T08:00:00Z`)
`updated_before`	datetime	否	返回在给定时间或之前更新的 issues。期望为 ISO 8601 格式 (`2019-03-15T08:00:00Z`)
`confidential`	boolean	否	筛选机密或公开的 issues。

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/issues_statistics"

示例响应：

{
  "statistics": {
    "counts": {
      "all": 20,
      "closed": 5,
      "opened": 15
    }
  }
}

获取群组 issues 统计

获取给定群组的 issues 计数统计。

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`	integer/string	是	群组的 ID 或 URL 编码路径
`labels`	string	否	标签名称的逗号分隔列表，issues 必须具有所有标签才会被返回。`None` 列出所有没有标签的 issues。`Any` 列出至少有一个标签的所有 issues。
`iids[]`	integer array	否	仅返回具有给定 `iid` 的 issues
`milestone`	string	否	里程碑标题。`None` 列出所有没有里程碑的 issues。`Any` 列出所有已分配里程碑的 issues。
`scope`	string	否	返回给定范围的 issues：`created_by_me`、`assigned_to_me` 或 `all`。
`author_id`	integer	否	返回由给定用户 `id` 创建的 issues。与 `author_username` 互斥。与 `scope=all` 或 `scope=assigned_to_me` 结合使用。
`author_username`	string	否	返回由给定 `username` 创建的 issues。与 `author_id` 类似，且与 `author_id` 互斥。
`assignee_id`	integer	否	返回分配给给定用户 `id` 的 issues。与 `assignee_username` 互斥。`None` 返回未分配的 issues。`Any` 返回有受理人的 issues。
`assignee_username`	string array	否	返回分配给给定 `username` 的 issues。与 `assignee_id` 类似，且与 `assignee_id` 互斥。在 GitLab CE 中，`assignee_username` 数组应仅包含单个值，否则会返回无效参数错误。
`my_reaction_emoji`	string	否	返回认证用户通过给定 `emoji` 表态的 issues。`None` 返回未表态的 issues。`Any` 返回至少有一个表态的 issues。
`search`	string	否	根据其 `title` 和 `description` 搜索群组 issues
`created_after`	datetime	否	返回在给定时间或之后创建的 issues。期望为 ISO 8601 格式 (`2019-03-15T08:00:00Z`)
`created_before`	datetime	否	返回在给定时间或之前创建的 issues。期望为 ISO 8601 格式 (`2019-03-15T08:00:00Z`)
`updated_after`	datetime	否	返回在给定时间或之后更新的 issues。期望为 ISO 8601 格式 (`2019-03-15T08:00:00Z`)
`updated_before`	datetime	否	返回在给定时间或之前更新的 issues。期望为 ISO 8601 格式 (`2019-03-15T08:00:00Z`)
`confidential`	boolean	否	筛选机密或公开的 issues。

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
    }
  }
}

获取项目 issues 统计

获取给定项目的 issues 计数统计。

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`	integer/string	是	项目的 ID 或 URL 编码路径
`iids[]`	integer array	否	仅返回具有给定 `iid` 的 milestone
`labels`	string	否	标签名称的逗号分隔列表，issues 必须具有所有标签才会被返回。`None` 列出所有没有标签的 issues。`Any` 列出至少有一个标签的所有 issues。
`milestone`	string	否	里程碑标题。`None` 列出所有没有里程碑的 issues。`Any` 列出所有已分配里程碑的 issues。
`scope`	string	否	返回给定范围的 issues：`created_by_me`、`assigned_to_me` 或 `all`。
`author_id`	integer	否	返回由给定用户 `id` 创建的 issues。与 `author_username` 互斥。与 `scope=all` 或 `scope=assigned_to_me` 结合使用。
`author_username`	string	否	返回由给定 `username` 创建的 issues。与 `author_id` 类似，且与 `author_id` 互斥。
`assignee_id`	integer	否	返回分配给给定用户 `id` 的 issues。与 `assignee_username` 互斥。`None` 返回未分配的 issues。`Any` 返回有受理人的 issues。
`assignee_username`	string array	否	返回分配给给定 `username` 的 issues。与 `assignee_id` 类似，且与 `assignee_id` 互斥。在 GitLab CE 中，`assignee_username` 数组应仅包含单个值，否则会返回无效参数错误。
`my_reaction_emoji`	string	否	返回认证用户通过给定 `emoji` 表态的 issues。`None` 返回未表态的 issues。`Any` 返回至少有一个表态的 issues。
`search`	string	否	根据其 `title` 和 `description` 搜索项目 issues
`created_after`	datetime	否	返回在给定时间或之后创建的 issues。期望为 ISO 8601 格式 (`2019-03-15T08:00:00Z`)
`created_before`	datetime	否	返回在给定时间或之前创建的 issues。期望为 ISO 8601 格式 (`2019-03-15T08:00:00Z`)
`updated_after`	datetime	否	返回在给定时间或之后更新的 issues。期望为 ISO 8601 格式 (`2019-03-15T08:00:00Z`)
`updated_before`	datetime	否	返回在给定时间或之前更新的 issues。期望为 ISO 8601 格式 (`2019-03-15T08:00:00Z`)
`confidential`	boolean	否	筛选机密或公开的 issues。

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
    }
  }
}