This type contains information about the pagination of a response payload. The entries (data records) returned by the request are grouped into pages, which are limited in size according to the number of entries per page as specified by the limit field.
Types that use PaginationOutput:
Calls that use PaginationOutput:
The value of the totalEntries field divided by the value of this field determines the value of the totalPages field.
0 and a limit of
10, the first page of the response contains the first 10 entries from the results set. If the offset was set to
10 and the limit was set to
20, the first page of the results set would contain entries 11-30.
The offset value defaults to
0 if the offset query parameter is omitted from the request.
This value is determined by dividing the value of the totalEntries field by the value of the limit field. If totalPages is more than
1, subsequent calls must be used to view subsequent pages in the results set.