Help Center/CodeArts Repo/API Reference/APIs/Repository/Obtaining Repository Statistics
Updated on 2025-05-15 GMT+08:00
View PDF

Obtaining Repository Statistics

Function

This API is used to obtain repository statistics.

URI

GET /v1/repositories/{repository_uuid}/statistic-data

Table 1 Path parameters

Parameter

Mandatory

Type

Description

repository_uuid

Yes

String

Explanation:

Repo UUID, which is returned by the CreateRepository API.

Constraints:

Mandatory

Range:

32 digits and letters.

Default value:

None

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token. It can be obtained by calling the corresponding IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints:

Mandatory

Range:

1–100,000 characters.

Default value:

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

error

Error object

Explanation:

Response error code.

result

RepositoryStatisticsVO object

Explanation:

Response result.

status

String

Explanation:

Response status of the API.

Range:

  • success: The API call is successful.
  • failed: The API call failed.
Table 4 Error

Parameter

Type

Description

code

String

Explanation:

Error code.

Range:

Max. 100 characters in the error code format.

message

String

Explanation:

Error message.

Range:

None

Table 5 RepositoryStatisticsVO

Parameter

Type

Description

repoName

String

Explanation:

Repository name.

commitCount

Integer

Explanation:

Number of commits.

repoSize

String

Explanation:

Repository capacity.

lastCommitTime

String

Explanation:

Last commit time.

codeLines

Integer

Explanation:

Lines of code.

branchCount

Integer

Explanation:

Number of branches.

archiveUrl

String

Explanation:

Code repository download address.

Example Requests

GET https://{endpoint}/v1/repositories/{repository_uuid}/statistic-data

Example Responses

Status code: 200

OK

{
  "result" : {
    "repoName" : "repoName",
    "commitCount" : "111",
    "repoSize" : "0.26 MB",
    "lastCommitTime" : "2020-01-01 11:11:11",
    "codeLines" : "368965",
    "branchCount" : "222",
    "archiveUrl" : "https://test.com/repo/v1/repo/repository/2111663431/archive"
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK

Error codes

See Error Codes.

Parent topic:Repository