Result Set Paging

Result set paging is supported for some API calls. The number of results returned and the relative starting offset of the result set is controlled by several parameters.

HTTP Query Parameters

Parameter	Description
pageSize	The number of records to return in this request. If omitted, the default value is 20. Raven deprecated setting a pageSize of 0 to return a complete and un-paged result set. Raven recommends a maximum page size of no more than 1000 to improve performance
page	The index of the result page to return. If omitted, the default value is 0.

Result Fields

Field Name	Description
TotalCount	The total number of records in the list being returned.
PageSize	The number of records returned in this request. This is controlled by the optional query string parameter "pageSize".
IsPreviousPage	A boolean value indicating if there are any pages prior to the current page in this list.
IsNextPage	A boolean value indicating if there are any pages after the current page in this list.
PageIndex	The index of the current page. The page index is zero based and has a maximum value of ([TotalPages] - 1). This is controlled by the optional query string parameter "page".
TotalPages	The total number of pages in this list given the [TotalCount] and [PageSize].