Help Center/ CodeArts Repo/ API Reference/ APIs/ Repository/ Obtaining the number of committed code lines
Updated on 2025-01-14 GMT+08:00

Obtaining the number of committed code lines

Function

This API is used to obtain the number of committed code lines of a specified branch in the code repository on a specified date.

URI

GET /v3/repositories/{repository_id}/commit-lines

Table 1 Path parameters

Parameter

Mandatory

Type

Description

repository_id

Yes

Integer

Repository short ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

ref_name

Yes

String

Branch name.

begin_date

Yes

String

Start commit date, in the format of yyyy-MM-dd.

end_date

Yes

String

End commit date, in the format of yyyy-MM-dd. The interval between begin_date and end_date cannot exceed 60 days.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

error

Error object

Response error.

result

CommitStatistic object

Number of added and deleted code lines.

status

String

Response status.

Table 5 Error

Parameter

Type

Description

code

String

Error code.

message

String

Error message.

Table 6 CommitStatistic

Parameter

Type

Description

additions

Integer

Number of added lines.

deletions

Integer

Number of deleted lines.

Example Requests

GET https://{endpoint}/v2/repositories/907199/commit-lines

Example Responses

Status code: 200

OK

{
  "result" : {
    "additions" : 9,
    "deletions" : 6
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.