reviews.rst

Reviews

Warning

These v3 APIs are now deprecated and you should switch to a newer version before it is removed. See the API versions available<api-versions-list> for details of the different API versions available and the deprecation timeline.

Note

The only authentication method available at the moment is the internal one<v3-api-auth-internal>.

List reviews

This endpoint allows you to fetch reviews for a given add-on or user. Either addon or user query parameters are required, and they can be combined together.

When addon, user and version are passed on the same request, page_size will automatically be set to 1, since an user can only post one review per version of a given add-on. This can be useful to find out if a user has already posted a review for the current version of an add-on.

By default, the review list API will only return not-deleted reviews, and include reviews without text. You can change that with the filter query parameter. You can filter by multiple values, e.g. filter=with_deleted,without_empty_body,with_yours

Value	Description
with_deleted	Returns deleted reviews too. This requires the Addons:Edit permission.
without_empty_body	Excludes reviews that only contain a rating, and no textual content.
with_yours	Used in combination without_empty_body to include your own reviews, even if they have no text.

Detail

This endpoint allows you to fetch a review by its id.

Post

This endpoint allows you to post a new review for a given add-on and version. If successful a review object <v3-review-detail-object> is returned.

Note

Requires authentication.

Edit

This endpoint allows you to edit an existing review by its id. If successful a review object <v3-review-detail-object> is returned.

Note

Requires authentication and Addons:Edit permissions or the user account that posted the review.

Only body, title and rating are allowed for modification.

Delete

This endpoint allows you to delete an existing review by its id.

Note

Requires authentication and Addons:Edit permission or the user account that posted the review. Even with the right permission, users can not delete a review from somebody else if it was posted on an add-on they are listed as a developer of.

Reply

This endpoint allows you to reply to an existing user review. If successful a review reply object <v3-review-detail-object> is returned.

Note

Requires authentication and either Addons:Edit permission or a user account listed as a developer of the add-on.

Flag

This endpoint allows you to flag an existing user review, to let a moderator know that something may be wrong with it.

Note

Requires authentication and a user account different from the one that posted the review.

Available constants for the flag property:

Constant	Description
review_flag_reason_spam	Spam or otherwise non-review content
review_flag_reason_language	Inappropriate language/dialog
review_flag_reason_bug_support	Misplaced bug report or support request
review_flag_reason_other	Other (please specify)