Contents

RequestPagination

Pagination settings specific to reporting requests.

Declaration

object RequestPagination

Properties

NameTypeDescription
offsetinteger

The starting position (zero-based index) for the result set (for example, 0 for the first page, 50 for the second page when pageSize is 50).

pageSizeinteger

The number of records to return per page. Maximum 5000, default 100.

Discussion

The RequestPagination controls which page of results is returned for a reporting request.

The ResponsePagination object on the report response returns the total number of available results. Use it to calculate how many additional pages exist and to determine the offset for subsequent requests when iterating through large result sets.

Example

{
  "offset": 0,
  "pageSize": 50
}

See Also