Help Center/ CodeArts Req/ API Reference/ APIs/ Project Indicators/ On-Time Completion Rate of Query Requirements

Updated on 2023-06-12 GMT+08:00

View PDF

On-Time Completion Rate of Query Requirements

Function

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the 32-bit ID of the devcloud project.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
date_range	No	String	Frequency
metric_type	No	String	Type
sprint_id	No	String	Iteration ID
dividend	No	dividend object	Counter Numerator Filter Criteria
divisor	No	Object	Indicator Denominator Filter Criteria

**Table 4** dividend
Parameter	Mandatory	Type	Description
on_time	No	String	On Time or Not
custom_field16	No	String	Custom Parameter
custom_field17	No	String	Custom Parameter
custom_field18	No	String	Custom Parameter
custom_field19	No	String	Custom Parameter
custom_field20	No	String	Custom Parameter
custom_field21	No	String	Custom Parameter
custom_field22	No	String	Custom Parameter
custom_field23	No	String	Custom Parameter
custom_field24	No	String	Custom Field
custom_field25	No	String	Custom Parameter
custom_field26	No	String	Custom Field
custom_field27	No	String	Custom Parameter
custom_field28	No	String	Custom Parameter
custom_field29	No	String	Custom Parameter
custom_field30	No	String	Custom Parameter
custom_field31	No	String	Custom Parameter
custom_field32	No	String	Custom Parameter
custom_field33	No	String	Custom Field
custom_field34	No	String	Custom Parameter
custom_field35	No	String	Custom Parameter
custom_field36	No	String	Custom Field
custom_field37	No	String	Custom Parameter
custom_field38	No	String	Custom Parameter
custom_field39	No	String	Custom Field
custom_field40	No	String	Custom Parameter

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
dividend_value	String	Numerator Value
divisor_value	String	Denominator
metric_name	String	Name
metric_value	String	Indicator Value
project_id	String	Project ID
project_name	String	Project

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Example Requests

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

{
  "date_range" : "1598457600000,1598544000000",
  "dividend" : {
    "custom_field16" : "Indicates the customized field value.",
    "on_time" : "ontime"
  },
  "divisor" : { },
  "metric_type" : "on-time_completion_rate",
  "sprint_id" : "8883443"
}

Example Responses

Status code: 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" : ""
}