Page Size Parameter

Syntax

The syntax for the page size parameter is:

s.ps=<pageSize>

A query string may contain only one s.ps parameter. The default value of this parameter, if unspecified, is 15. The maximum value of this parameter is 50 and the maximum number of records possible is 1000.


Function

The page size parameter works with the page number parameter to control the offset of the records returned in the results. It also controls how many results are returned with each request.

Example - Using the page size parameter

This query string returns documents 5 to 8 of the total result set:
 
  s.pn=2&s.ps=4

Error Messages

  {
    "errors": [
        {
            "code": "page.size.too.large",
            "message": "Maximum supported page size is 50 (provided size is 51)."
        }
    ],
    "sessionId": "48eba240-3d05-4e6c-b0f2-3bd30b34b5bd",
    "spotlightPosition": 0,
    "version": "2.0.0"
  }

  {
    "errors": [
        {
            "code": "results.size.too.large",
            "message": "Maximum supported returned results set size is 1000 (provided size is 1050)."
        }
    ],
    "sessionId": "48eba240-3d05-4e6c-b0f2-3bd30b34b5bd",
    "spotlightPosition": 0,
    "version": "2.0.0"
  }

Try It