Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Repository/ Obtaining the Status of a Repository Statistics Task
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Obtaining the Status of a Repository Statistics Task

Function

This API is used to obtain the status of the repository statistics task.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsrepo:repository:getRepository

Read

-

-

-

-

URI

GET https://{hostURL}/v4/repositories/{repository_id}/repository/statistics-status

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

repository_id

Yes

Integer

Definition

You can query the project list to obtain the repository ID by calling the API used to query user's all repositories.

Constraints

N/A

Default Value

N/A

Value range:

1~2147483647

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints

N/A

Range

1–100,000 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response header parameters

Parameter

Type

Description

X-Total

String

Definition

Total number of results of the current request.
Table 4 Response body parameters

Parameter

Type

Description

can_statistics

Boolean

Definition

Can be statistically calculated or not.

Range

  • true: yes.

  • false: no.

reason

Integer

Definition

Can be statistically calculated or not.

Range

  • 0: user triggers and repository triggers are not used up.

  • 1: repository triggers are used up.

  • 2: user triggers are used up.

  • 3: user triggers and repository triggers are used up.

Default value:

0

Enumeration values:

  • 0

  • 1

  • 2

  • 3

event

StatisticEventsDto object

Event
Table 5 StatisticEventsDto

Parameter

Type

Description

id

Integer

Definition

Statistics ID.

Default Value

N/A

Value range:

1~2147483647

user_id

Integer

Definition

User ID.

Default Value

N/A

Value range:

1~2147483647

project_id

Integer

Definition

Repository ID.

Default Value

N/A

Value range:

1~2147483647

branch

String

Definition

Branch name.

Range

1 to 200 bytes.

Default Value

N/A

status

String

Definition

Statistics status.

Default Value

0

stat_date

String

Definition

Statistics time.

created_at

String

Definition

Statistics creation time.

updated_at

String

Definition

Statistics update time.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

GET https://{endpoint}/v4/repositories/2111915566/repository/statistics-status

Example Responses

Status code: 200

Obtain repository statistics task status

{
  "can_statistics" : false,
  "reason" : 0,
  "event" : {
    "id" : 0,
    "user_id" : 0,
    "project_id" : 0,
    "branch" : "branch_bb453f4359fc",
    "status" : "status_6a687650fc63",
    "stat_date" : "20250604",
    "created_at" : "2025-06-04T16:14:29+08:00",
    "updated_at" : "2025-06-04T16:14:29+08:00"
  }
}

Status code: 401

Unauthorized

{
  "error_code" : "CH.00000001",
  "error_msg" : "User authentication info not found."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.00401008",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status code: 404

Not Found

{
  "error_code" : "CH.00402000",
  "error_msg" : "The repository does not exist. Check and try again."
}

Status Codes

Status Code

Description

200

Obtain repository statistics task status

401

Unauthorized

403

Bad Request

404

Not Found

Error Codes

See Error Codes.

Parent topic: Repository