Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Repository/ Obtaining Repository Dynamics

Updated on 2026-01-27 GMT+08:00

View PDF

Obtaining Repository Dynamics

Function

This API is used to obtain repository dynamics. (Only dynamic push available now)

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}/events

**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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
author_id	No	Integer	Definition Operator ID. Value range: 1~2147483647
filter	No	String	Definition Dynamic type. Constraints all: indicates all. push: indicates the push. Default value: all Enumeration values: all push
before	No	String	Definition Start date.
after	No	String	Definition End date.
offset	No	Integer	Definition Offset, which starts from 0. Value range: 0~2147483647 Default value: 0
limit	No	Integer	Definition Number of returned records. Value range: 1~100 Default value: 20

Request Parameters

**Table 3** 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 4** Response header parameters
Parameter	Type	Description
X-Total	String	Definition Total number of results of the current request.

**Table 5** Response body parameters
Parameter	Type	Description
[items]	Array of RepositoryPushEventDto objects	Definition Push dynamics.

**Table 6** RepositoryPushEventDto
Parameter	Type	Description
action_name	String	Definition Action name. pushed to: indicates the push. pushed new: indicates the push and creation. deleted: indicates deletion. Enumeration values: pushed to pushed new deleted
author	RepositoryEventAuthorDto object	Definition Information of the user who triggers the operation.
author_id	Integer	Definition ID of the user who triggers the operation. Value range: 1~2147483647
author_username	String	Definition Name of the user who triggers the operation.
created_at	String	Definition Creation time.
repository_id	Integer	Definition Repository ID. Value range: 1~2147483647
repository_name	String	Definition Repository name.
push_data	PushEventPayloadDto object	Definition Push information.

**Table 7** RepositoryEventAuthorDto
Parameter	Type	Description
id	Integer	Definition User ID. Value range: 1~2147483647
name	String	Definition Username.
username	String	Definition Username.
state	String	Definition: User status Value range: active: activated blocked: disabled Enumeration values: active blocked
avatar_url	String	Definition Profile picture URL.
name_cn	String	Definition Name (CN).
nick_name	String	Definition Alias.
tenant_name	String	Definition Tenant name.

**Table 8** PushEventPayloadDto
Parameter	Type	Description
commit_count	Integer	Definition Number of commits. Value range: 1~2147483647
action	String	Definition Operation type.
ref_type	String	Definition Ref type.
commit_from	String	Definition Source commit.
commit_to	String	Definition Target commit.
ref	String	Definition Branch.
commit_title	String	Definition Commit title.

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Status code: 404

**Table 11** 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/10001/events

Example Responses

Status code: 200

Repository dynamics list.

[ {
  "action_name" : "pushed new",
  "author" : {
    "id" : 9124,
    "name" : "dev_test",
    "username" : "c369c68f1ff84679b5a8ed904d8bff1c",
    "state" : "active",
    "avatar_url" : "",
    "name_cn" : "dev_test",
    "nick_name" : "dev",
    "tenant_name" : "test_tenant"
  },
  "author_id" : 9124,
  "author_username" : "c369c68f1ff84679b5a8ed904d8bff1c",
  "created_at" : "2024-08-21T06:21:22.000Z",
  "repository_id" : 2111694664,
  "repository_name" : "lhtest00002/RepoProtal",
  "push_data" : {
    "commit_count" : 0,
    "action" : "created",
    "ref_type" : "branch",
    "commit_from" : null,
    "commit_to" : "17933c207b320a74dc10af80e0d9d9720a90dd5e",
    "ref" : "asdsada#fasdasda",
    "commit_title" : null
  }
} ]

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	Repository dynamics list.
401	Unauthorized
403	Bad Request
404	Not Found

Error Codes

See Error Codes.

Parent topic: Repository

Previous topic: Obtaining Statistics on the Default Branch Language of a Repository

Next topic: Comparing Branches, Tags, and Commits

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot