Skip to content

Draft: Add performance analytics group level api

Add performance analytics group level api

  1. 总面板接口 groups/*group_id/-/analytics/performance_analytics/summary.json

    参数格式

    • project_ids 项目ID数组
    • start_date 查询开始日期(查询时转化为UTC日期的开始时间00:00:00)
    • end_date 查询结束日期(查询时转化为UTC日期的结束时间23:59:59)

    返回数据

    {
      "issues_closed": 0, 
      "commits_pushed": 0,
      "merge_requests_merged": 0,
      "commits_pushed_per_capita": 0
    }
  2. 榜单接口 groups/*group_id/-/analytics/performance_analytics/leaderboard.json

    参数格式

    • project_ids 项目ID数组
    • start_date 查询开始日期(查询时转化为UTC日期的开始时间00:00:00)
    • end_date 查询结束日期(查询时转化为UTC日期的结束时间23:59:59)
    • leaderboard_type 榜单类型 commits_pushed issues_closed merge_requests_merged

    返回数据

    [
      { 
         "user": {
            "fullname": "Linjie Zhang",
            "username": "zhanglinjie",
            "user_web_url": "/zhanglinjie",
            "avatar": "/uploads/-/system/user/avatar/290/avatar.png?width=30"
         },
         "rank": 1,
         "value": 100
      } 
    ]
  3. 报表数据接口 groups/*group_id/-/analytics/performance_analytics/report.json

    参数格式

    • project_ids 项目ID数组
    • start_date 查询开始日期(查询时转化为UTC日期的开始时间00:00:00)
    • end_date 查询结束日期(查询时转化为UTC日期的结束时间23:59:59)
    • page 分页码 默认为1
    • sort 排序列 username commits_pushed issues_closed...
    • direction 排序方向 asc增序 desc降序

    返回数据(分页信息在返回头中)

    [
      { 
         "user": {
            "fullname": "Linjie Zhang",
            "username": "zhanglinjie",
            "user_web_url": "/zhanglinjie",
            "avatar": "/uploads/-/system/user/avatar/290/avatar.png?width=30"
         },
         "commits_pushed": 0,
         "issues_closed": 0,
         "issues_created": 0,
         "merge_requests_approved": 0,
         "merge_requests_closed": 0,
         "merge_requests_created": 0,
         "merge_requests_merged": 0,
         "notes_created": 0,
      } 
    ]
  4. 报表数据导出接口 groups/*group_id/-/analytics/performance_analytics/report.csv

    参数格式

    • project_ids 项目ID数组
    • start_date 查询开始日期(查询时转化为UTC日期的开始时间00:00:00)
    • end_date 查询结束日期(查询时转化为UTC日期的结束时间23:59:59)
Linjie Zhang 编辑于

合并请求报告

加载中