Divide large sets of response data into manageable and easy-to-process pages
Why use Pagination
Pagination improves resource consumption and performance by sending only the necessary data and doing so in a timely manner.
A single large response message might be inefficient to exchange and process, especially when returning data for human consumption. Pagination reduces the individual message size by dividing it into smaller pages. It has the potential to significantly diminish response time for data access, reduce data weight by limiting payload size, and provide a consumable data presentation format.
Pagination parameters
PARAMETER | EXPLANATION | Default | Min | Max |
---|---|---|---|---|
PageNumber | Specify the page number. | 1 | 1 | 9999 |
PageSize | Indicates the number of instances to return on each page. | 100 | 10 | 500 |
Example
Sample request will look like:
https://sandbox.upswot.com/admin/api/v1/normalized-data/companies?PageNumber=1&PageSize=100
Currently, each endpoint that supports pagination returns a pagination object:
{
"pageNumber": 1,
"pageSize": 100,
"count": 2,
"data": [
...
]
}