get by review

Get Reports by Review

The endpoint retrieves the reports for a specific review based on the provided review ID, with optional pagination parameters for page number and limit.

The response for this request can be documented as a JSON schema as follows:

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "reports": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "_id": { "type": "string" },
                  "review": {
                    "type": "object",
                    "properties": {
                      "_id": { "type": "string" },
                      "book": { "type": "string" },
                      "review": { "type": "string" },
                      "reviewer": { "type": "string" },
                      "rating": { "type": "number" },
                      "upvoters": { "type": "array" },
                      "downvoters": { "type": "array" },
                      "isRemoved": { "type": "boolean" },
                      "createdAt": { "type": "string" },
                      "updatedAt": { "type": "string" },
                      "__v": { "type": "number" }
                    }
                  },
                  "reporter": {
                    "type": "object",
                    "properties": {
                      "_id": { "type": "string" },
                      "firstName": { "type": "string" },
                      "lastName": { "type": "string" },
                      "userName": { "type": "string" },
                      "email": { "type": "string" },
                      "role": { "type": "string" },
                      "createdAt": { "type": "string" },
                      "updatedAt": { "type": "string" },
                      "__v": { "type": "number" }
                    }
                  },
                  "reason": { "type": "string" },
                  "isResolved": { "type": "boolean" },
                  "createdAt": { "type": "string" },
                  "updatedAt": { "type": "string" },
                  "__v": { "type": "number" }
                }
              }
            },
            "totalDocs": { "type": "number" },
            "offset": { "type": "number" },
            "limit": { "type": "number" },
            "totalPages": { "type": "number" },
            "page": { "type": "number" },
            "pagingCounter": { "type": "number" },
            "hasPrevPage": { "type": "boolean" },
            "hasNextPage": { "type": "boolean" },
            "prevPage": { "type": "null" },
            "nextPage": { "type": "null" }
          }
        },
        "error": { "type": "null" }
      }
    }
  }
}

GET /reports/review/{reviewId}

get by review

cURL

curl --request GET \
  --url http://localhost:8000/v1/reports/review/{reviewId}

200

get by review - success1

{
  "data": {
    "reports": {
      "docs": [],
      "hasNextPage": false,
      "hasPrevPage": false,
      "limit": 10,
      "nextPage": null,
      "offset": 0,
      "page": 1,
      "pagingCounter": 1,
      "prevPage": null,
      "totalDocs": 0,
      "totalPages": 1
    }
  },
  "error": null
}

Path Parameters

reviewId · string · required

Example:

"670e317b59f06fc0a2501117"

Query Parameters

page · string

Example:

"1"

limit · string

Example:

"10"

Response

200

application/json

get by review - success1 / get by review - success2

data · object

Show child attributes

error · unknown