Pagination

Pagination allows you to limit the number of items returned by the list operation and provides information on how to get other pages.

Query Parameters

• startIndex: Specfies the index of the item at which to start. Zero-based: 0 is the first item.
• resultsPerPage: Specifies the number of items to retrieve. Minimum:1. Default: 25. Maximum: 100.

Returned Parameters

• totalResults: Total number of items.
• resultsPerPage: Number of items requested per page.
• startIndex: The index of the first item returned. If you request a startIndex that is greater than total items, a full last page is returned.
• nextPage: The URL to get the next page. This parameter is not returned if you are on the last page.
• prevPage: The URL to get the previous page. This parameter is not returned if you are on the first page.
• firstPage: The URL to get the first page.
• lastPage: The URL to get the last page.
• searchTerm: The value specified in the search query parameter. See Search.
• sortTerm: The value specified in the sort query parameters. See Sort.

Example Response

Copy<pageInfo>
      <resultsPerPage>2</resultsPerPage>
      <startindex>0</startIndex>
      <totalResults>10</totalResults>
       <firstPage>  http://<server>/bucketIntervals/?resultsPerPage=2</firstPage>
       <lastPage> http://<server>/bucketIntervals/?startIndex=8&resultsPerPage=2</lastPage>
      <prevPage/>
      <nextPage> http://<server>/bucketIntervals/?startIndex=2&resultsPerPage=2</nextPage>
 </pageInfo>

<bucketIntervals>
   <bucketInterval/>
   <bucketInterval/>
</bucketIntervals>