PageInfo

  • This documentation details the structure of a JSON response for paginated API results.

  • The response includes the total number of results, the number of results per page, and the starting index of the current page.

  • This information is used to navigate through large datasets by displaying results in manageable chunks.

Information about the current page.

List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned.

JSON representation 
{
  "totalResults": integer,
  "resultPerPage": integer,
  "startIndex": integer
}
Fields
totalResults

integer

Total number of results available on the backend ! The total number of results in the result set.
resultPerPage

integer

Maximum number of results returned in one page. ! The number of results included in the API response.
startIndex

integer

Index of the first result returned in the current page.