Help Center/ CodeArts Repo/ API Reference/ APIs/ Repository/ Repository Statistics
Updated on 2026-04-28 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 parameter

Parameter

Mandatory

Type

Description

repository_id

Yes

Integer

Explanation:

Repository ID.

Constraints:

N/A

Range:

1–2147483647

Default value:

N/A

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

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

Constraints:

N/A

Range:

1–100,000 characters.

Default value

N/A
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

branch_name

Yes

String

Explanation:

Branch name.

Constraints:

N/A

Range:

1–2,000

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

error

Error object

Explanation:

Response error code.

Range:

N/A

result

RepoStatisticsLaunch object

Explanation:

Response result.

Range:

N/A

status

String

Explanation:

Response status.

Range:

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

Parameter

Type

Description

code

String

Explanation:

Error code.

Range:

Max. 100 characters in the error code format.

message

String

Explanation:

Error message.

Range:

N/A
Table 6 RepoStatisticsLaunch

Parameter

Type

Description

can_statistics

Boolean

Explanation:

Whether the repository statistics can be collected.

Range:

  • true: The repository statistics can be collected.
  • false: The repository statistics cannot be collected.

join_id

String

Explanation:

Task ID for starting repository statistics collection.

Range:

N/A

message

String

Explanation:

Information returned after repository statistics collection is started.

Range:

N/A

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 Code

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Repository