Help Center/ CodeArts Req/ API Reference/ API/ IPD Statistics Overview/ Obtaining Statistics Panel Data
Updated on 2025-09-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

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.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API.

Constraints:

Regular expression: ^[A-Za-z0-9]{32}$

Options:

N/A

Default value:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

classification

Yes

String

Definition:

Statistics type.

Constraints:

Regular expression: (requirement|bug)

Options:

requirement and bug

requirement: queries requirement statistics.

bug: queries bug statistics.

Default value:

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Definition:

User token. Obtain the token by calling theObtaining a User TokenIAM API. In the returned response header, X-Subject-Token is the desired user token.

Constraints:

Mandatory.

Range:

Minimum length: 10 character. Maximum length: 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 Querying the Release/Sprint Plan List API. The id in PlanVO in the returned parameters is the release plan ID.

Constraints:

Regular expression: [0-9]{18,19}

Options:

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:

Regular expression: [0-9]{18,19}

Options:

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:

Regular expression: [0-9]{13,19}

Options:

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:

Regular expression: [0-9]{13,19}

Options:

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:

Request status.

Options:

N/A

message

String

Definition:

Request failure information.

Options:

N/A
Table 8 DashboardSimpleVO

Parameter

Type

Description

category

String

Definition:

Work item type.

Options:

For system device projects, the options are RR, SF, IR, SR, AR, Task, and Bug. For standalone software projects, the options are RR, SF, IR, US, Task, and Bug. For cloud service projects, the options are RR, Epic, FE, US, Task, and Bug.

total

Integer

Definition:

Total number of work items.

Options:

N/A

processing

Integer

Definition:

Number of work items being processed.

Options:

N/A

completed

Integer

Definition:

Number of completed work items.

Options:

N/A

expired

Integer

Definition:

Number of overdue work items.

Options:

N/A

remain_di

Double

Definition:

DI of unresolved bugs. The statistical scope includes all non-closed and non-draft bugs in the project.

Options:

DI = Warning × 0.1 + Minor × 1 + Major × 3 + Critical × 10

category_name

String

Definition:

Statistics panel name.

Options:

N/A

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

http://localhost:8083/ipdprojectservice/v3/projects/0f516b2816e044efb51f301dd55941a2/statistic?classification=bug

{ }

Example Responses

Status code: 200

Statistics success response.

{
  "status" : "success",
  "message" : null,
  "result" : [ {
    "category" : "RR",
    "total" : 0,
    "processing" : 0,
    "completed" : 0,
    "expired" : 0,
    "category_name" : "Raw requirement."
  }, {
    "category" : "SF",
    "total" : 2,
    "processing" : 1,
    "completed" : 0,
    "expired" : 0,
    "category_name" : "System feature"
  }, {
    "category" : "IR",
    "total" : 2,
    "processing" : 1,
    "completed" : 0,
    "expired" : 1,
    "category_name" : "Initial requirement"
  }, {
    "category" : "SR",
    "total" : 1,
    "processing" : 0,
    "completed" : 0,
    "expired" : 0,
    "category_name" : "System requirement"
  }, {
    "category" : "AR",
    "total" : 1,
    "processing" : 0,
    "completed" : 0,
    "expired" : 0,
    "category_name" : "Allocated requirement"
  }, {
    "category" : "Task",
    "total" : 1,
    "processing" : 0,
    "completed" : 0,
    "expired" : 0,
    "category_name" : "Task"
  }, {
    "category" : "Bug",
    "total" : 5,
    "processing" : 0,
    "completed" : 0,
    "expired" : 0,
    "category_name" : "Bug"
  } ]
}

Status code: 400

Response indicating collection failure

{
  "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