Inactive Users API

POST /inactiveUsers

Description

This API endpoint retrieves a paginated list of inactive users.

Request Body

The request uses GraphQL to perform the inactiveUsers query.

Query:

query inactiveUsers ($page: Int, $size: Int) {
    inactiveUsers (page: $page, size: $size) {
        totalElements
        size
        number
    }
}

GraphQL Variables:

{
  "page": 0,
  "size": 0
}

Example Request:

curl --location '' \
--header 'Content-Type: application/json' \
--data '{"query":"query inactiveUsers ($page: Int, $size: Int) {\n    inactiveUsers (page: $page, size: $size) {\n        totalElements\n        size\n        number\n    }\n}","variables":{"page":0,"size":0}}'

Response:

• Success (200 OK):

  • The response includes pagination details for inactive users.

  {
    "data": {
      "inactiveUsers": {
        "totalElements": 300,
        "size": 10,
        "number": 1
      }
    }
  }
  • totalElements: Total number of inactive users.
  • size: Number of inactive users per page.
  • number: Current page number.

• Error (4XX/5XX):

  • If there is an issue with the request or if there is a server error, the response will include an error message and status code.

Note:

This endpoint provides paginated data on inactive users, which is useful for managing user activity and implementing re-engagement strategies. Adjust the page and size parameters to navigate through the results.