Pagination

Pagination means results are divided into pages, requiring multiple requests to access all data.

Each request fetches a part of the total results, indicating the current page.

To effectively use these APIs:

1. Start by requesting the first page with paged=true in the header (default page size is 20).

2. Extract data from the response, then check for more pages using the pageable metadata, which shows total and current page numbers.

3. For additional pages, increment the page number in the query (e.g., set page=1 for the next page). Worth noting that page index starts at 0.

4. Combine results from all pages into one list.

Benefits of Pagination:

• Existing non-paginated requests remain functional but can be slow or truncated with large volumes.

• Paginated requests (paged=true) are faster and more reliable, limited to a specified page size (default 20).

• We aim to phase out non-paginated results, focusing solely on pagination.

Pagination isn't yet supported for the Actions and Statistics APIs but will be added later.