Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ MergeRequest/ Obtaining the Average Rating of a Merge Request

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

View PDF

Obtaining the Average Rating of a Merge Request

Function

This API is used to obtain the average rating of a merge request.

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:getMergeRequest	Read	-	-	-	-

URI

GET https://{hostURL}/v4/repositories/{repository_id}/merge-requests/{merge_request_iid}/average-evaluation

**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
merge_request_iid	Yes	Integer	Definition MR internal ID (IID). 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 body parameters
Parameter	Type	Description
merge_request_id	Integer	Definition MR ID. Value range: 1~2147483647
average_evaluation_level	Double	Definition Average score of the evaluation.
evaluations	Array of MergeRequestBaseEvaluationDto objects	Definition Evaluation details of a single user.
custom_evaluations	Array of MergeRequestCustomAverageEvaluationDto objects	Definition Custom evaluation dimension details.

**Table 4** MergeRequestBaseEvaluationDto
Parameter	Type	Description
id	Integer	Definition Evaluation ID. Value range: 1~2147483647
merge_request_id	Integer	Definition MR ID. Value range: 1~2147483647
level	Integer	Definition Score. Value range: 0~5
created_at	String	Definition Creation time.
updated_at	String	Definition Update time.
content	String	Definition Evaluation text.
user	UserBasicDto object	Definition Evaluation author.

**Table 5** UserBasicDto
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: available account blocked: locked user error: The user is not found Enumeration values: active blocked error
service_license_status	Integer	Service-level permission status. 0: disabled; 1: enabled
avatar_url	String	User profile picture URL
avatar_path	String	User profile picture path
email	String	User email
name_cn	String	Username (CN)
web_url	String	User homepage
nick_name	String	User alias
tenant_name	String	Tenant name
error_message	String	Definition When some query APIs detect that the user permission in the transfer parameter is insufficient or the user does not exist, the user is returned but the field is not empty for information.

**Table 6** MergeRequestCustomAverageEvaluationDto
Parameter	Type	Description
evaluation_type_id	Integer	Definition Custom evaluation dimension ID.
name	String	Definition Name of a custom evaluation dimension.
level	Double	Definition Average scores of custom evaluation dimensions.

Status code: 401

**Table 7** 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/2112015538/merge-requests/1/average-evaluation

Example Responses

Status code: 200

Obtain the average rating of merge requests.

{
  "merge_request_id" : 3302539,
  "average_evaluation_level" : 4.0,
  "evaluations" : [ {
    "id" : 119953,
    "merge_request_id" : 3302539,
    "level" : 5,
    "created_at" : "2025-06-20T19:10:59.028+08:00",
    "updated_at" : "2025-06-20T19:10:59.028+08:00",
    "content" : 5,
    "user" : {
      "id" : 223385,
      "name" : "example_name",
      "username" : "example_name",
      "state" : "active",
      "avatar_url" : "https://example.com/w3lab/rest/yellowpage/face/example_name/120",
      "avatar_path" : null,
      "email" : "example_name_nobody@example.com",
      "name_cn" : "example_name example_name",
      "web_url" : "https://example.com/example_name",
      "nick_name" : null,
      "tenant_name" : null
    }
  } ],
  "custom_evaluations" : null
}

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code	Description
200	Obtain the average rating of merge requests.
401	Unauthorized

Error Codes

See Error Codes.

Parent topic: MergeRequest

Previous topic: Obtaining All Conflict Files

Next topic: Obtaining the Merge Request Review Evaluation List

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