Issues Statistics API

原文:https://docs.gitlab.com/ee/api/issues_statistics.html

Issues Statistics API

每个对 issue_statistics 的 API 调用都必须经过身份验证.

如果用户不是项目成员,并且该项目是私有项目,则对该项目的GET请求将导致404状态代码.

Get issues statistics

获取有关经过身份验证的用户有权访问的所有问题的问题计数统计信息. 默认情况下,它仅返回当前用户创建的问题. 要获取所有问题,请使用参数scope=all .

  1. GET /issues_statistics
  2. GET /issues_statistics?labels=foo
  3. GET /issues_statistics?labels=foo,bar
  4. GET /issues_statistics?labels=foo,bar&state=opened
  5. GET /issues_statistics?milestone=1.0.0
  6. GET /issues_statistics?milestone=1.0.0&state=opened
  7. GET /issues_statistics?iids[]=42&iids[]=43
  8. GET /issues_statistics?author_id=5
  9. GET /issues_statistics?assignee_id=5
  10. GET /issues_statistics?my_reaction_emoji=star
  11. GET /issues_statistics?search=foo&in=title
  12. GET /issues_statistics?confidential=true
Attribute Type Required Description
labels string no 标签名称的逗号分隔列表,必须具有要返回的所有标签的问题. None列出所有没有标签的问题. Any列出至少带有一个标签的所有问题.
milestone string no 里程碑标题. None列出没有里程碑的所有问题. Any列出具有指定里程碑的所有问题.
scope string no 回到问题在给定范围: created_by_meassigned_to_meall . 默认为created_by_me
author_id integer no 返回由给定用户id创建的问题. 与author_username . 与scope=allscope=assigned_to_me结合使用.
author_username string no 返回由给定username创建的问题. 类似于author_id并且与author_id .
assignee_id integer no Return issues assigned to the given user id. Mutually exclusive with assignee_username. None returns unassigned issues. Any returns issues with an assignee.
assignee_username 字符串数组 no 返回分配给给定username . 类似于assignee_id并且与assignee_id互斥. 在 GitLab CE 中, assignee_username数组应仅包含单个值,否则将返回无效的参数错误.
my_reaction_emoji string no 返回的问题由已验证的用户通过给定的emoji响应. None返回没有响应的问题. 至少有一个反应, Any回报问题.
iids[] 整数数组 no 仅返回具有给定iid的问题
search string no 根据titledescription搜索问题
in string no 修改search属性的范围. titledescription或以逗号将它们连接在一起的字符串. 默认为title,description
created_after datetime no 返回在给定时间或之后创建的问题
created_before datetime no 返回在给定时间或之前创建的问题
updated_after datetime no 返回在给定时间或之后更新的问题
updated_before datetime no 返回在给定时间或之前更新的问题
confidential boolean no 过滤机密或公共问题.
  1. curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/issues_statistics"

响应示例:

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

Get group issues statistics

获取给定组的问题计数统计信息.

  1. GET /groups/:id/issues_statistics
  2. GET /groups/:id/issues_statistics?labels=foo
  3. GET /groups/:id/issues_statistics?labels=foo,bar
  4. GET /groups/:id/issues_statistics?labels=foo,bar&state=opened
  5. GET /groups/:id/issues_statistics?milestone=1.0.0
  6. GET /groups/:id/issues_statistics?milestone=1.0.0&state=opened
  7. GET /groups/:id/issues_statistics?iids[]=42&iids[]=43
  8. GET /groups/:id/issues_statistics?search=issue+title+or+description
  9. GET /groups/:id/issues_statistics?author_id=5
  10. GET /groups/:id/issues_statistics?assignee_id=5
  11. GET /groups/:id/issues_statistics?my_reaction_emoji=star
  12. GET /groups/:id/issues_statistics?confidential=true
Attribute Type Required Description
id integer/string yes 认证用户拥有的组的 ID 或URL 编码路径
labels string no 标签名称的逗号分隔列表,必须具有要返回的所有标签的问题. None列出所有没有标签的问题. Any列出至少带有一个标签的所有问题.
iids[] 整数数组 no 仅返回具有给定iid的问题
milestone string no 里程碑标题. None列出没有里程碑的所有问题. Any列出具有指定里程碑的所有问题.
scope string no 回到问题在给定范围: created_by_meassigned_to_meall .
author_id integer no 返回由给定用户id创建的问题. 与author_username . 与scope=allscope=assigned_to_me结合使用.
author_username string no 返回由给定username创建的问题. 类似于author_id并且与author_id .
assignee_id integer no 返回分配给给定用户id . 互斥与assignee_username . None返回未分配的问题. 受让人有Any退货问题.
assignee_username 字符串数组 no 返回分配给给定username . 类似于assignee_id并且与assignee_id互斥. 在 GitLab CE 中, assignee_username数组应仅包含单个值,否则将返回无效的参数错误.
my_reaction_emoji string no 返回的问题由已验证的用户通过给定的emoji响应. None返回没有响应的问题. 至少有一个反应, Any回报问题.
search string no 搜索组问题的titledescription
created_after datetime no 返回在给定时间或之后创建的问题
created_before datetime no 返回在给定时间或之前创建的问题
updated_after datetime no 返回在给定时间或之后更新的问题
updated_before datetime no 返回在给定时间或之前更新的问题
confidential boolean no 过滤机密或公共问题.
  1. curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/4/issues_statistics"

响应示例:

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

Get project issues statistics

获取给定项目的问题计数统计信息.

  1. GET /projects/:id/issues_statistics
  2. GET /projects/:id/issues_statistics?labels=foo
  3. GET /projects/:id/issues_statistics?labels=foo,bar
  4. GET /projects/:id/issues_statistics?labels=foo,bar&state=opened
  5. GET /projects/:id/issues_statistics?milestone=1.0.0
  6. GET /projects/:id/issues_statistics?milestone=1.0.0&state=opened
  7. GET /projects/:id/issues_statistics?iids[]=42&iids[]=43
  8. GET /projects/:id/issues_statistics?search=issue+title+or+description
  9. GET /projects/:id/issues_statistics?author_id=5
  10. GET /projects/:id/issues_statistics?assignee_id=5
  11. GET /projects/:id/issues_statistics?my_reaction_emoji=star
  12. GET /projects/:id/issues_statistics?confidential=true
Attribute Type Required Description
id integer/string yes 经过身份验证的用户拥有的项目的 ID 或URL 编码路径
iids[] 整数数组 no 仅返回具有给定iid的里程碑
labels string no 标签名称的逗号分隔列表,必须具有要返回的所有标签的问题. None列出所有没有标签的问题. Any列出至少带有一个标签的所有问题.
milestone string no 里程碑标题. None列出没有里程碑的所有问题. Any列出具有指定里程碑的所有问题.
scope string no 回到问题在给定范围: created_by_meassigned_to_meall .
author_id integer no 返回由给定用户id创建的问题. 与author_username . 与scope=allscope=assigned_to_me结合使用.
author_username string no 返回由给定username创建的问题. 类似于author_id并且与author_id .
assignee_id integer no 返回分配给给定用户id . 互斥与assignee_username . None返回未分配的问题. 受让人有Any退货问题.
assignee_username 字符串数组 no 返回分配给给定username . 类似于assignee_id并且与assignee_id互斥. 在 GitLab CE 中, assignee_username数组应仅包含单个值,否则将返回无效的参数错误.
my_reaction_emoji string no 返回的问题由已验证的用户通过给定的emoji响应. None返回没有响应的问题. 至少有一个反应, Any回报问题.
search string no 根据titledescription搜索项目问题
created_after datetime no Return issues created on or after the given time
created_before datetime no 返回在给定时间或之前创建的问题
updated_after datetime no 返回在给定时间或之后更新的问题
updated_before datetime no 返回在给定时间或之前更新的问题
confidential boolean no 过滤机密或公共问题.
  1. curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/4/issues_statistics"

响应示例:

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