Help Center/ CodeArts Check/ API Reference/ APIs/ Code Metrics/ Querying Code Measurement Summary
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Code Measurement Summary

Function

This API is used to query the code measurement summary of a version or quality gate scan, including the task code.

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:ProjectId

URI

GET /v1/defects/task-measures

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

task_id

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

merge_id

No

String

Definition

Merge request ID or commit ID. They are used to query quality gate tasks.

Constraints

N/A

Range

N/A

Default Value

N/A

job_id

No

String

Definition

Execution record ID, that is, the unique ID of each version or quality gate scan. The ID is used to query quality gate tasks.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 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

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

TaskMeasures object

Definition:

Code metrics summary.
Table 4 TaskMeasures

Parameter

Type

Description

codeLineTotal

String

Definition:

Original code lines, including blank and comment lines.

Value range:

N/A

codeLine

String

Definition:

Valid code lines, excluding blank and comment lines.

Value range:

N/A

duplications

String

Definition:

Code duplication rate.

Value range:

N/A

complexityFileAvg

String

Definition:

Average cyclomatic complexity.

Value range:

N/A

Status code: 400

Table 5 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 6 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 code measurement summary of the latest version scan under task ID 897acf5exxx48a5013cd.

GET https://{endpoint}/v1/defects/task-measures?task_id=897acf5exxx48a5013cd

Example Responses

Status code: 400

Bad Request

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

Status code: 401

Unauthorized

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

Status Codes

Status Code

Description

200

Issue summary

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Code Metrics