Help Center/ CodeArts Repo/ API Reference/ APIs/ Repository/ Obtains the number of submitted code lines.
Updated on 2023-09-12 GMT+08:00

Obtains the number of submitted code lines.

Function

Obtains the number of submitted 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

Warehouse Short ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

ref_name

Yes

String

Branch Name

begin_date

Yes

String

Submission start date, in the format of yyyy-MM-dd.

end_date

Yes

String

Submission end date, in the format 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

Specifies the user token.

It can be obtained by calling an IAM API. 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 lines added and deleted in the code

status

String

Status code in a response

Table 5 Error

Parameter

Type

Description

code

String

Error Codes

message

String

Error message

Table 6 CommitStatistic

Parameter

Type

Description

additions

Integer

Number of added lines.

deletions

Integer

Number of rows deleted

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.