all

Get All Reports

This endpoint retrieves a list of reports with pagination.

Request

• Method: GET

• URL: /reports/all

• Query Parameters:

  • page (number, required): The page number for pagination.

  • limit (number, required): The maximum number of reports to be returned per page.

Response

The response will be a JSON object with the following schema:

{
  "data": {
    "reports": {
      "docs": [
        {
          "_id": "string",
          "review": "string",
          "reporter": {
            "_id": "string",
            "firstName": "string",
            "lastName": "string",
            "userName": "string",
            "email": "string",
            "role": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "__v": 0
          },
          "reason": "string",
          "isResolved": true,
          "createdAt": "string",
          "updatedAt": "string",
          "__v": 0
        }
      ],
      "totalDocs": 0,
      "offset": 0,
      "limit": 0,
      "totalPages": 0,
      "page": 0,
      "pagingCounter": 0,
      "hasPrevPage": true,
      "hasNextPage": true,
      "prevPage": null,
      "nextPage": null
    },
    "error": null
  }
}

GET /reports/all

all

cURL

curl --request GET \
  --url http://localhost:8000/v1/reports/all

200

{
  "data": {
    "reports": {
      "docs": [
        {
          "__v": 0,
          "_id": "670e386a648069ca43164df6",
          "createdAt": "2024-10-15T09:39:54.100Z",
          "isResolved": false,
          "reason": "Bad review",
          "reporter": {
            "__v": 0,
            "_id": "6708d54f9c193b2aeae09b80",
            "createdAt": "2024-10-11T07:35:43.468Z",
            "email": "[e-mail]",
            "firstName": "abebebch",
            "lastName": "kebede",
            "role": "user",
            "updatedAt": "2024-10-15T08:49:39.357Z",
            "userName": "abebekebede1"
          },
          "review": null,
          "updatedAt": "2024-10-15T09:39:54.100Z"
        }
      ],
      "hasNextPage": false,
      "hasPrevPage": false,
      "limit": 10,
      "nextPage": null,
      "offset": 0,
      "page": 1,
      "pagingCounter": 1,
      "prevPage": null,
      "totalDocs": 1,
      "totalPages": 1
    }
  },
  "error": null
}

Query Parameters

page · string

Example:

"1"

limit · string

Example:

"10"

Response

200

application/json

all - success

data · object

Show child attributes

error · unknown