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

Repository Statistics

Function

This API is used to query code commit record statistics of a repository by the repository short ID.

URI

POST /v1/repositories/{repository_id}/statistics

Table 1 Path parameters

Parameter

Mandatory

Type

Description

repository_id

Yes

Integer

Repository primary key ID.

Request Parameters

Table 2 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

branch_name

Yes

String

Repository branch name.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

error

Error object

Response error.

result

RepoStatisticsLaunch object

Response result.

status

String

Response status.
Table 5 Error

Parameter

Type

Description

code

String

Error code.

message

String

Error message.
Table 6 RepoStatisticsLaunch

Parameter

Type

Description

can_statistics

Boolean

Indicates whether the warehouse can collect statistics.

join_id

String

sidekiq task ID.

message

String

Information returned after repository statistics collection is started.

Example Requests

POST https://{endpoint}/v1/repositories/{repository_id}/statistics

{
  "branch_name" : "master"
}

Example Responses

Status code: 200

OK

{
  "result" : {
    "can_statistics" : false,
    "message" : "operation success",
    "join_id" : "2a48a9fd140dd4efabcc6e07"
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Repository