Help Center/ CodeArts Check/ API Reference/ APIs/ Issue Management/ Querying Issue Details Statistics
Updated on 2025-08-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Issue Details Statistics

Function

This API is used to query issue details statistics based on a task ID.

Calling Method

For details, see Calling APIs.

URI

GET /v2/tasks/{task_id}/defects-statistic

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Definition

Task ID, returned by the API for creating a check task. Each CodeArts Check task, branch task, or incremental task generated through an API has a unique ID.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

time_info_switch

No

String

Definition

Whether to query the check start time and end time.

Constraints

N/A

Range

  • true: Query the check start time and end time.

  • false: Do not query the check start time and end time.

Default Value

false

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 forobtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

1–100,000 characters

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

severity

StatisticSeverityV2 object

Definition

Number of issues of each severity level.

status

StatisticStatusV2 object

Definition

Number of issues in each status.

last_check_time

String

Definition

Check start time. Format: 2025-07-21T03:38:53Z.

Range

N/A

last_check_finish_time

String

Definition

Check end time. Format: 2025-07-21T03:38:53Z.

Range

N/A
Table 5 StatisticSeverityV2

Parameter

Type

Description

critical

Integer

Definition

Number of critical issues.

Range

N/A

major

Integer

Definition

Number of major issues.

Range

N/A

minor

Integer

Definition

Number of minor issues.

Range

N/A

suggestion

Integer

Definition

Number of suggestions.

Range

N/A
Table 6 StatisticStatusV2

Parameter

Type

Description

unresolved

Integer

Definition

Number of pending issues.

Range

N/A

resolved

Integer

Definition

Number of resolved and fixed issues.

Range

N/A

dismissed

Integer

Definition

Number of ignored issues.

Range

N/A

fixed

Integer

Definition

Number of fixed issues.

Range

N/A

solved

Integer

Definition

Number of resolved issues.

Range

N/A

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Query issue details statistics under task ID 2b31ed520xxxxxxebedb6e57xxxxxxxx.

GET https://{endpoint}/v2/tasks/2b31ed520xxxxxxebedb6e57xxxxxxxx/defects-statistic

null

Example Responses

Status code: 200

Request succeeded!

{
  "severity" : {
    "critical" : 120,
    "major" : 877,
    "minor" : 79,
    "suggestion" : 3
  },
  "status" : {
    "unresolved" : 877,
    "resolved" : 79,
    "dismissed" : 5,
    "fixed" : 70,
    "solved" : 9
  }
}

Status code: 400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "Network busy. Try again later."
}

Status code: 401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code

Description

200

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Issue Management