Help Center/ CodeArts Check/ API Reference/ APIs/ Code Issues/ Obtaining Code Issue Statistics

Updated on 2026-08-10 GMT+08:00

Obtaining Code Issue Statistics

Function

This API is used to query code issue statistics that meet specified conditions.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
codeartscheck:task:getReport	Read	task *	-	-	-
codeartscheck:task:getReport	Read	-	codeartscheck:ProjectId	-	-

URI

POST /v1/defect/issue-filter

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Language	No	String	Definition: Language of the response. Constraints: N/A Value range: zh-cn: Chinese. en-us: English. Default value: zh-cn

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
taskId	Yes	String	Definition : Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID. Constraints: N/A Value range: 1 to 32 characters. Default value: N/A
mergeId	No	String	Definition: Merge request ID. This parameter is only used to distinguish version and quality gate scans. Leave it blank for a version scan and pass any non-empty value for a quality gate scan. Constraints: N/A Range: N/A Default value: N/A
jobId	No	String	Definition: Execution ID, which is returned by the API of code check task execution. Each code check task has a unique execution ID. Leave this parameter blank for a version scan and pass a value for a quality gate scan. That is, the ID field in the response of API Querying Task Execution Record by Task ID. Constraints: N/A Value range: 1 to 32 characters. Default value: N/A
facets	Yes	String	Definition: Items to be included in statistics. Separate them with commas (,). Constraints: N/A Value range: languages: programming languages ruleIds: rule IDs authors: issue owners isNew: whether issues are new statusIds: issue statuses severities: issue severities delayStatus: issue phases fileNames: file names userTags: tags cwes: CWE IDs Default value: N/A
languages	No	String	Definition: Programming language. Constraints: N/A. Value range: Python Java C++ CSS PHP JavaScript Go HTML C# TypeScript Shell Lua Rust Kotlin Scala ArkTS SQL Cangjie Default value: N/A.
ruleIds	No	String	Definition: Rule ID. When this API is called, the facets parameter is passed to ruleIds. If the response body Facet.property is ruleIds, the value of FacetItem.val is the rule ID. Constraints: N/A Value range: N/A Default value: N/A
authors	No	String	Definition: Username of the issue owner. Constraints: N/A Range: N/A Default value: N/A
isNew	No	String	Definition: Whether only news issues are shown. Constraints: N/A Value range: 0: all issues. 1: new issues. Default value: N/A
statusIds	No	String	Definition: Issue status. Constraints: N/A. Value range: 0: pending 2: resolved 5: ignored 6: fixed Default value: N/A.
severities	No	String	Definition: Issue severity. Constraints: N/A Value range: 0: critical 1: major 2: minor 3: suggestion Default value: N/A
delayStatus	No	String	Definition: Issue phase. Constraints: N/A Value range: 0: immediate. 1: deferred. Default value: N/A
fileNames	No	String	Definition: File name for exact match. Constraints: N/A Range: N/A Default value: N/A
userTags	No	Array of strings	Definition Tag. When this API is called, the facets parameter is passed to userTags. If the response body Facet.property is userTags, the value of FacetItem.val is the tag. Constraints N/A Range N/A Default Value N/A
cwes	No	Array of strings	Definition CWE IDs. When this API is called, the facets parameter is passed to cwes. If the response body Facet.property is cwes, the value of FacetItem.val is the CWE ID. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
status	String	Definition: Response status. Value range: success: successful. error: failed.
result	Array of IssueFilter objects	Definition: Statistics on code issues by dimension.

**Table 4** IssueFilter
Parameter	Type	Description
facets	Array of Facet objects	Definition: Statistics in each dimension.

**Table 5** Facet
Parameter	Type	Description
property	String	Definition: Dimensions. Value range: languages: programming languages ruleIds: rule IDs authors: issue owners isNew: whether issues are new statusIds: issue statuses severities: issue severities delayStatus: issue phases fileNames: file names userTags: tags cwes: CWE IDs
values	Array of FacetItem objects	Definition: Number of issues of different categories in a dimension.

**Table 6** FacetItem
Parameter	Type	Description
val	String	Definition: Categories in a dimension. Categories can be the issue status, issue severity, owner, rule ID, or other classifications. Value range: N/A
count	String	Definition: Quantity. Range: N/A

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: N/A
error_msg	String	Definition: Error message. Value range: N/A

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: N/A
error_msg	String	Definition: Error message. Value range: N/A

Example Requests

Query the number of issues detected in the latest version-level scan of the task whose ID is 897acf5exxx48a5013cd. All major issues are counted based on the issue status.

POST https://{endpoint}/v1/defect/issue-filter

{
  "taskId" : "897acf5exxx48a5013cd",
  "jobId" : "",
  "mergeId" : "",
  "facets" : "statuses",
  "statusIds" : "",
  "severities" : "1",
  "delayStatus" : "",
  "isNew" : "",
  "languages" : "",
  "authors" : "",
  "fileNames" : "",
  "ruleIds" : ""
}

Example Responses

Status code: 200

Response body for collecting code issue statistics by dimension.

{
  "status" : "success",
  "error" : null,
  "result" : {
    "total" : null,
    "info" : [ ],
    "facets" : [ {
      "values" : [ {
        "val" : "0",
        "id" : null,
        "count" : "1",
        "nickName" : null,
        "parentId" : null,
        "sort" : null
      }, {
        "val" : "5",
        "id" : null,
        "count" : "999",
        "nickName" : null,
        "parentId" : null,
        "sort" : null
      }, {
        "val" : "6",
        "id" : null,
        "count" : "1237",
        "nickName" : null,
        "parentId" : null,
        "sort" : null
      } ],
      "trees" : [ ],
      "property" : "statuses"
    }, {
      "values" : [ {
        "val" : "0",
        "id" : null,
        "count" : "119",
        "nickName" : null,
        "parentId" : null,
        "sort" : null
      }, {
        "val" : "1",
        "id" : null,
        "count" : "602",
        "nickName" : null,
        "parentId" : null,
        "sort" : null
      }, {
        "val" : "2",
        "id" : null,
        "count" : "516",
        "nickName" : null,
        "parentId" : null,
        "sort" : null
      }, {
        "val" : "3",
        "id" : null,
        "count" : "1000",
        "nickName" : null,
        "parentId" : null,
        "sort" : null
      } ],
      "trees" : [ ],
      "property" : "severities"
    } ]
  }
}

Status code: 400

A request error occurred.

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

Status code: 401

The permission is insufficient.

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

Status Codes

Status Code	Description
200	Response body for collecting code issue statistics by dimension.
400	A request error occurred.
401	The permission is insufficient.

Error Codes

See Error Codes.

Parent Topic: Code Issues

Previous topic: Obtaining Code Issues

Next topic: Querying Code Issues