本文导读

展开导读

文档首页/ 需求管理 CodeArts Req/ API参考/ API/ 项目指标/ 查询需求按时完成率

查询需求按时完成率

更新时间：2025-05-22 GMT+08:00

查看PDF

功能介绍

查询需求按时完成率

URI

POST /v1/{project_id}/completion-rate/query

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	devcloud项目的32位id

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表3 请求Body参数
参数	是否必选	参数类型	描述
date_range	否	String	统计周期
metric_type	否	String	指标类型
sprint_id	否	String	迭代ID
dividend	否	dividend object	指标分子过滤条件
divisor	否	Object	指标分母过滤条件

表4 dividend
参数	是否必选	参数类型	描述
on_time	否	String	是否按时
custom_field16	否	String	自定义字段
custom_field17	否	String	自定义字段
custom_field18	否	String	自定义字段
custom_field19	否	String	自定义字段
custom_field20	否	String	自定义字段
custom_field21	否	String	自定义字段
custom_field22	否	String	自定义字段
custom_field23	否	String	自定义字段
custom_field24	否	String	自定义字段
custom_field25	否	String	自定义字段
custom_field26	否	String	自定义字段
custom_field27	否	String	自定义字段
custom_field28	否	String	自定义字段
custom_field29	否	String	自定义字段
custom_field30	否	String	自定义字段
custom_field31	否	String	自定义字段
custom_field32	否	String	自定义字段
custom_field33	否	String	自定义字段
custom_field34	否	String	自定义字段
custom_field35	否	String	自定义字段
custom_field36	否	String	自定义字段
custom_field37	否	String	自定义字段
custom_field38	否	String	自定义字段
custom_field39	否	String	自定义字段
custom_field40	否	String	自定义字段

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
dividend_value	String	指标分子数值
divisor_value	String	指标分母数值
metric_name	String	指标名称
metric_value	String	指标数值
project_id	String	项目ID
project_name	String	项目名称

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_msg	String	错误描述
error_code	String	错误码

状态码：401

表7 响应Body参数
参数	参数类型	描述
error_msg	String	错误描述
error_code	String	错误码

请求示例

Post https://{endpoint}/v1/eace9c0a00574de6878ab580daa9a317/completion-rate/query

{
  "date_range" : "1598457600000,1598544000000",
  "dividend" : {
    "custom_field16" : "自定义字段值",
    "on_time" : "ontime"
  },
  "divisor" : { },
  "metric_type" : "on-time_completion_rate",
  "sprint_id" : "8883443"
}

响应示例

状态码：200

{
  "dividend_value" : 15,
  "divisor_value" : 20,
  "metric_name" : "completion_rate|bug_density|bugs_per_developer",
  "metric_value" : 0.8945,
  "project_id" : "eace9c0a00574de6878ab580daa9a317",
  "project_name" : "我的项目"
}

状态码


状态码	描述
200	OK
400	Bad Request
401	Unauthorized

错误码

请参见错误码。

父主题： 项目指标

上一篇：查询人均bug

下一篇：查询缺陷密度

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

查询需求按时完成率

功能介绍

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

意见反馈

文档内容是否对您有帮助？

文档反馈