Help Center/ CodeArts Check/ API Reference/ APIs/ Code Metrics/ Obtaining the Code Metrics File List V2
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Code Metrics File List V2

Function

This API is used to obtain the file metrics information with pagination based on the task ID.

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

POST /v2/measure/measure-list

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

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

filterType

No

String

Definition:

Filter criteria.

Constraints:

N/A

Value range:

  • comment_ratio: comment ratio.

  • complexitySmall: file cyclomatic complexity ≤ 5.

  • complexityBig: file cyclomatic complexity > 5.

  • ratioSmall: file code duplication rate ≤ 15%.

  • ratioBig: file code duplication rate > 15%.

Default value:

N/A

sortField

No

String

Definition:

Sorting field.

Constraints:

N/A

Value range:

  • codeDuplicationRatio: file code duplication rate.

  • codeDuplicationLines: number of duplicate lines.

  • cyclomaticComplexityFile: file cyclomatic complexity.

Default value:

N/A

sortType

No

String

Definition:

Sort order.

Constraints:

N/A

Value range:

  • ASC: ascending order

  • DESC: descending order

Default value:

N/A

search

No

String

Definition:

Search by file name.

Constraints:

N/A

Range:

N/A

Default value:

N/A

page

No

Integer

Definition:

Page number.

Constraints:

N/A

Range:

≥1

Default value:

N/A

pageSize

No

Integer

Definition:

Page size.

Constraints:

N/A

Range:

1-20

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

result object

Definition:

The result of obtaining code metrics files.
Table 4 result

Parameter

Type

Description

total

Integer

Definition:

Total number.

Value range:

N/A

measureProjectInfos

Array of MeasureProjectInfo objects

Definition:

File metrics information.
Table 5 MeasureProjectInfo

Parameter

Type

Description

id

Integer

Definition:

Metrics file ID.

Value range:

N/A

filePathId

String

Definition:

File path ID.

Value range:

N/A

filePath

String

Definition:

File path.

Value range:

N/A

language

String

Definition:

Programming language.

Value range:

  • Python

  • Java

  • C++

  • CSS

  • PHP

  • JavaScript

  • Go

  • HTML

  • C#

  • TypeScript

  • Shell

  • Lua

  • Rust

  • Kotlin

  • Scala

  • ArkTS

  • SQL

  • Cangjie

codeDuplicationLines

String

Definition:

Number of duplicate code lines.

Value range:

N/A

rawLines

String

Definition:

Lines of code.

Value range:

N/A

codeDuplicationRatio

String

Definition:

Code duplication rate.

Value range:

N/A

cyclomaticComplexityFile

String

Definition:

File cyclomatic complexity.

Value range:

N/A

commentRatio

String

Definition:

Comment line percentage.

Value range:

N/A

Status code: 400

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

Status code: 401

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

Example Requests

  • Query the code measurement files of task ID 897acf5exxx48a5013cd, with 20 records on each page, and return the first page.

    POST https://{endpoint}/v2/measure/measure-list

{
  "page" : 1,
  "pageSize" : 20,
  "jobId" : "",
  "taskId" : "897acf5exxx48a5013cd",
  "sortField" : "",
  "filterType" : "",
  "sortType" : "",
  "search" : ""
}

  • Query the file comment rate list of task ID 897acf5exxx48a5013cd, with 20 records on each page, and return the first page.

    POST https://{endpoint}/v2/measure/measure-list

{
  "page" : 1,
  "pageSize" : 20,
  "jobId" : "",
  "taskId" : "897acf5exxx48a5013cd",
  "sortField" : "",
  "filterType" : "comment_ratio",
  "sortType" : "",
  "search" : ""
}

Example Responses

Status code: 200

Request succeeded!

{
  "status" : "success",
  "error" : null,
  "result" : {
    "total" : "1",
    "measureProjectInfos" : [ {
      "id" : 499506,
      "filePathId" : "b4426edc-0ed5-49a1-a62a-42c970e7ff17",
      "filePath" : "worker/src/main/java/worker/Worker.java",
      "language" : "JAVA",
      "codeDuplicationLines" : "0",
      "rawLines" : "109",
      "codeDuplicationRatio" : "0%",
      "cyclomaticComplexityFile" : "14"
    } ]
  }
}

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

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Code Metrics