removed by user

Get Removed Reviews by User

This endpoint retrieves removed reviews for a specific user.

Request

• Method: GET
• Endpoint: {{baseUrl}}/reviews/user/:userId/removed
• Query Parameters:
  • page (number, optional): The page number for paginated results.
  • limit (number, optional): The maximum number of reviews per page.

Response

The response will contain an object with the following properties:

• data (object): The container for the response data.
  • reviews (object): The container for the retrieved reviews.
    • docs (array): An array of removed review objects, each containing the review details.
      • _id (string): The unique identifier of the review.
      • book (string): The book associated with the review.
      • review (string): The content of the review.
      • reviewer (string): The reviewer of the review.
      • rating (number): The rating given in the review.
      • upvoters (array): An array of upvoters for the review.
      • downvoters (array): An array of downvoters for the review.
      • isRemoved (boolean): Indicates if the review is removed.
      • createdAt (string): The timestamp of review creation.
      • updatedAt (string): The timestamp of review update.
      • __v (number): Version key for internal use.
    • totalDocs (number): The total number of removed reviews.
    • offset (number): The offset for the current page.
    • limit (number): The maximum number of reviews per page.
    • totalPages (number): The total number of pages.
    • page (number): The current page number.
    • pagingCounter (number): The paging counter.
    • hasPrevPage (boolean): Indicates if there is a previous page.
    • hasNextPage (boolean): Indicates if there is a next page.
    • prevPage (number): The previous page number.
    • nextPage (number): The next page number.
• error (null): If an error occurs, it will be populated with the error details.

GET /reviews/user/{userId}/removed

removed by user

cURL

curl --request GET \
  --url http://localhost:8000/v1/reviews/user/{userId}/removed

200

removed by user - success

{
  "data": {
    "reviews": {
      "docs": [
        {
          "__v": 0,
          "_id": "670e334f59f06fc0a250112d",
          "book": "670e16f0d058e963ea3dd770",
          "createdAt": "2024-10-15T09:18:07.685Z",
          "downvoters": [],
          "isRemoved": true,
          "rating": 5,
          "review": "A new review for a great book, Gilead.",
          "reviewer": "6708d54f9c193b2aeae09b80",
          "updatedAt": "2024-10-15T09:25:46.716Z",
          "upvoters": []
        }
      ],
      "hasNextPage": false,
      "hasPrevPage": false,
      "limit": 10,
      "nextPage": null,
      "offset": 0,
      "page": 1,
      "pagingCounter": 1,
      "prevPage": null,
      "totalDocs": 1,
      "totalPages": 1
    }
  },
  "error": null
}

Path Parameters

userId · string · required

Example:

"6708d54f9c193b2aeae09b80"

Query Parameters

page · string

Example:

"1"

limit · string

Example:

"10"

Response

200

application/json

removed by user - success / removed by user - success1

data · object

Show child attributes

error · unknown