Help Center/ CodeArts Req/ API Reference/ APIs/ Project Statistics/ Obtaining the Project Overview

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

View PDF

Obtaining the Project Overview

Function

URI

GET /v4/projects/{project_id}/summary

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

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. Minimum: 10 Maximum: 32768

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
bug_statistics	Array of BugStatisticResponseV4 objects	Bug Statistics List
demand_statistics	Array of DemandStatisticResponseV4 objects	List of Statistics by Module
issue_completion_rates	Array of IssueCompletionRateResponseV4 objects	List of Statistics by Work Item Type
project_id	String	Project ID

**Table 4** BugStatisticResponseV4
Parameter	Type	Description
critical_num	Integer	Indicates the number of critical bugs.
defect_index	Double	DI
module	String	Module
normal_num	Integer	Indicates the number of minor bugs.
serious_num	Integer	Number of Major Defects
tip_num	Integer	Indicates the number of trivial bugs.
total	Integer	Total

**Table 5** DemandStatisticResponseV4
Parameter	Type	Description
closed_num	Integer	Closed Qty.
module	String	Module
new_num	Integer	Number of new sites.
process_num	Integer	Quantity in Development
rejected_num	Integer	Rejected Qty.
solved_num	Integer	Resolved Issues
test_num	Integer	Quantity in the Test
total	Integer	Total

**Table 6** IssueCompletionRateResponseV4
Parameter	Type	Description
issue_status	IssueStatusResponseV4 object	Work item statistics.
tracker_id	Integer	Work item type. The options are as follows: 2: task; 3: defect /Bug,5Epic,6Feature,7Story.

**Table 7** IssueStatusResponseV4
Parameter	Type	Description
closed_num	Integer	Closed Qty.
new_num	Integer	Number of new sites.
process_num	Integer	Quantity in Development
rejected_num	Integer	Rejected Qty.
solved_num	Integer	Resolved Issues
test_num	Integer	Quantity in the Test

Status code: 400

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

Status code: 401

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

Example Requests

GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/summary

GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/summary

Example Responses

Status code: 200

{
  "bug_statistics" : [ {
    "critical_num" : 0,
    "defect_index" : 1,
    "module" : "",
    "normal_num" : 1,
    "serious_num" : 0,
    "tip_num" : 0,
    "total" : 1
  } ],
  "demand_statistics" : [ {
    "closed_num" : 1,
    "module" : "cost",
    "new_num" : 1,
    "process_num" : 1,
    "rejected_num" : 1,
    "solved_num" : 1,
    "test_num" : 1,
    "total" : 1
  } ],
  "issue_completion_rates" : [ {
    "issue_status" : {
      "closed_num" : 1,
      "new_num" : 1,
      "process_num" : 1,
      "rejected_num" : 1,
      "solved_num" : 1,
      "test_num" : 1
    },
    "tracker_id" : 0
  } ],
  "project_id" : "526cefde62004de2b62b5e8dd2c2b3af"
}