Request parameters for submitting a new review
| Field | Type | Label | Description |
| app_id | string | Identifier of the application being reviewed |
|
| user_id | string | Identifier of the user submitting the review |
|
| score | uint32 | Rating score (1-5 stars) |
|
| comment | string | Text feedback for the application |
|
| tenant_id | string | Identifier for multi-tenant isolation |
Response data after submitting a review
| Field | Type | Label | Description |
| review | Review | The newly created review object |
|
| success | bool | Indicates if the review was successfully created |
|
| message | string | Additional information about the operation result |
Request parameters for deleting a review
| Field | Type | Label | Description |
| review_id | string | Identifier of the review to delete |
|
| tenant_id | string | Identifier for multi-tenant isolation |
Response data after deleting a review
| Field | Type | Label | Description |
| success | bool | Indicates if the deletion was successful |
|
| message | string | Additional information about the operation result |
Request parameters for fetching a specific review
| Field | Type | Label | Description |
| review_id | string | Identifier of the review to retrieve |
|
| tenant_id | string | Identifier for multi-tenant isolation |
Response data for single review retrieval
| Field | Type | Label | Description |
| review | Review | The requested review object |
Request parameters for fetching reviews
| Field | Type | Label | Description |
| app_id | string | Identifier of the application to get reviews for |
|
| page | uint32 | Page number for pagination |
|
| page_size | uint32 | Number of reviews per page |
|
| include_moderated_only | bool | Filter to show only moderated reviews |
|
| tenant_id | string | Identifier for multi-tenant isolation |
Response data for review retrieval
| Field | Type | Label | Description |
| reviews | Review | repeated | List of reviews matching the request criteria |
| total_count | uint32 | Total number of reviews available |
|
| average_score | double | Average rating score across all reviews |
Request parameters for moderating a review
| Field | Type | Label | Description |
| review_id | string | Identifier of the review to moderate |
|
| moderation_status | ModerationType | New moderation status to apply |
|
| moderator_id | string | Identifier of the staff member performing moderation |
|
| moderation_note | string | Internal notes about the moderation decision |
|
| tenant_id | string | Identifier for multi-tenant isolation |
Response data after moderating a review
| Field | Type | Label | Description |
| success | bool | Indicates if the moderation was successful |
|
| message | string | Additional information about the operation result |
|
| updated_review | Review | The review object after moderation changes |
Review represents a user's rating and comment for an application
| Field | Type | Label | Description |
| id | string | Unique identifier for the review |
|
| app_id | string | Identifier of the application being reviewed |
|
| user_id | string | Identifier of the user who wrote the review |
|
| score | uint32 | Rating score given by the user (1-5 stars) |
|
| comment | string | Text feedback provided by the user |
|
| created_at | string | Timestamp when the review was submitted |
|
| is_moderated | bool | Indicates if the review has gone through moderation |
|
| moderation_status | ModerationType | Current moderation status of the review (PENDING/APPROVED/REJECTED) |
|
| tenant_id | string | Identifier for multi-tenant isolation |
Request parameters for updating a review
| Field | Type | Label | Description |
| review_id | string | Identifier of the review to update |
|
| tenant_id | string | Identifier for multi-tenant isolation |
|
| score | uint32 | Updated rating score |
|
| comment | string | Updated review comment |
Response data after updating a review
| Field | Type | Label | Description |
| review | Review | The updated review object |
|
| success | bool | Indicates if the update was successful |
|
| message | string | Additional information about the operation result |
Moderation statuses for review management
| Name | Number | Description |
| PENDING | 0 | Review awaiting moderation check |
| APPROVED | 1 | Review has passed moderation and is publicly visible |
| REJECTED | 2 | Review has failed moderation and is hidden from public view |
| Method Name | Request Type | Response Type | Description |
| AddReview | AddReviewRequest | AddReviewResponse | Create |
| GetReview | GetReviewRequest | GetReviewResponse | Read |
| GetReviews | GetReviewsRequest | GetReviewsResponse | |
| UpdateReview | UpdateReviewRequest | UpdateReviewResponse | Update |
| DeleteReview | DeleteReviewRequest | DeleteReviewResponse | Delete |
| ModerateComment | ModerateCommentRequest | ModerateCommentResponse | Existing moderation endpoint |
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
| double | double | double | float | float64 | double | float | Float | |
| float | float | float | float | float32 | float | float | Float | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| bool | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |