Help Center/ CodeArts Repo/ API Reference/ APIs/ Repository/ Repository Statistics

Updated on 2023-12-04 GMT+08:00

View PDF

Repository Statistics

Function

This API is used to query the code submission record statistics of a repository based on the repository short ID.

URI

POST /v1/repositories/{repository_id}/statistics

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
repository_id	Yes	Integer	Primary key ID of a warehouse.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies a 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.

**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	Result
status	String	Status code in a response

**Table 5** Error
Parameter	Type	Description
code	String	Error Codes
message	String	Error message

**Table 6** RepoStatisticsLaunch
Parameter	Type	Description
can_statistics	Boolean	Indicates whether the warehouse can collect statistics.
join_id	String	Specifies the ID of the sidekiq task.
message	String	Information returned after warehouse statistics collection is started.

Example Requests

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

{
  "branch_name" : "master"
}

Example Responses

Status code: 200

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