Pagination
Each response from the API represents a page of up to 4000 sessions. The result-set for a query will most likely return much more than 4000 sessions, so consumers are required to page or scroll through the result-set.
Each response from the endpoint includes a next_page_id
parameter. The next_page_id
parameter is used to obtain the next page of sessions. To ensure that all sessions which match the query are retrieved from the API, consumers must repeatedly call the endpoint with the same query parameters and including the next_page_id
from the previous page.
Note: When a consumer has reached the end of the result-set, the sessions
key on the final response will be empty.
The examples section shows how this can be achieved.