Obtaining Statistics Panel Data

Function

This API is used to obtain the requirement/bug statistic data. The data will be delayed for 5 to 10 minutes.

Calling Method

For details, see Calling APIs.

Authorization Information

No identity policy-based permission required for calling this API.

URI

POST /v1/ipdprojectservice/projects/{project_id}/statistic/dashboard

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition 32-character ID of a project, which must be unique. Obtain the value by calling the API for querying the IPD project list. The value of id in the response message body is the project ID. Constraints N/A Range A string of 32 characters consisting of letters and digits. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
classification	Yes	String	Definition Statistics type. Constraints N/A Range requirement: Query requirement statistics. bug: Query bug statistics. Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range 10 to 32,768 characters Default Value N/A

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
plan	No	PlanFilter object	Definition Release plan filter criteria. Constraints N/A
created_date	No	DateFilter object	Definition Filter criteria for work item creation time. Constraints N/A

**Table 5** PlanFilter
Parameter	Mandatory	Type	Description
plan_pi	No	String	Definition ID of a release plan when the statistics are collected by sprint plan. You can query the release plan ID by calling the API for querying the release/sprint plan list. The id in PlanVO in the returned parameters is the release plan ID. Constraints A string of 18 to 19 digits. Range N/A Default Value N/A
plan_iteration	No	String	Definition ID of the sprint plan when the statistics are collected by sprint plan. Constraints A string of 18 to 19 digits. Range N/A Default Value N/A

**Table 6** DateFilter
Parameter	Mandatory	Type	Description
start_date	No	String	Definition The work item creation time cannot be earlier than this time. Timestamp of 00:00 on date d. Constraints A string of 13 to 19 digits. Range N/A Default Value N/A
end_date	No	String	Definition The work item creation time cannot be later than this time. The timestamp is 00:00 on the date d+1. Constraints A string of 13 to 19 digits. Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
result	Array of DashboardSimpleVO objects	Definition Statistical result.
status	String	Definition Response status. Range success: The response is returned successfully. error: The response fails.
message	String	Definition Request failure information. Range N/A

**Table 8** DashboardSimpleVO
Parameter	Type	Description
category	String	Definition Work item type. Range Multiple values are supported. Use commas (,) to separate them. For system device projects, options include RR, SF, IR, SR, AR, Task, and Bug. For standalone software projects, options include RR, SF, IR, US, Task, and Bug.
total	Integer	Definition Total number of work items. Range N/A
processing	Integer	Definition Number of work items being processed. Range N/A
completed	Integer	Definition Number of completed work items. Range N/A
uncompleted	Integer	Definition Number of uncompleted work items. Range N/A
expired	Integer	Definition Number of overdue work items. Range N/A
remain_di	Double	Definition DI of unresolved bugs. The statistical scope includes all non-closed and non-draft bugs in the project. Range DI = Warning × 0.1 + Minor × 1 + Major × 3 + Critical × 10
category_name	String	Definition Statistics panel name. Range N/A

Status code: 400

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code. Range N/A
error_msg	String	Definition Error description, which is a supplement to error_code. Range N/A

Example Requests

Statistics on bugs in the project whose ID is a75f1c34cbf24e5fbbbc154dd823cd8e

POST https://{endpoint}/v1/ipdprojectservice/projects/a75f1c34cbf24e5fbbbc154dd823cd8e/statistic/dashboard?classification=bug

{ }

Example Responses

Status code: 200

{
  "status" : "success",
  "message" : "",
  "result" : [ {
    "category" : "Bug",
    "total" : 2,
    "processing" : 1,
    "completed" : 0,
    "uncompleted" : 2,
    "expired" : 0,
    "remain_di" : 0.2,
    "category_name" : "Bug overview statistics."
  } ]
}

Status code: 400

{
  "error_code" : "PM.02175302",
  "error_msg" : "Service busy: ISSUE_SERVICE"
}

Status Codes

Status Code	Description
200	Statistics success response.
400	Response indicating collection failure

Error Codes

See Error Codes.

Parent topic: IPD Statistics Overview

Previous topic: IPD Statistics Overview

Next topic: IPD Module Management