Data source pagination🔗
Warning
Pagination is only supported for the REST datasource type.
It is possible to consume a paginated REST data source.
Pagination is a technique used in web APIs to split large datasets into smaller, more manageable pieces. This is particularly useful when dealing with large amounts of data, as it reduces the amount of data that needs to be processed and transmitted at once, making the API more responsive and efficient.
Warning
Note that the pagination configuration can vary depending on the API being consumed. It is important to consult the API documentation to determine the correct pagination configuration to use.
Available parameters🔗
type : The type of pagination used. Either next or pagecount.
location: Location of the pagination metadata. Either body or headers.
slurp_mode: How to slurp the data. full fetches all page and slurps them afterwards. page slurps every page one after another.
page_count_path : The name of the header containing the total number of pages or a JSONPath expression if it's in the payload (depends on type above).
current_page_path: The name of the header containing the current page number or a JSONPath expression if it's in the payload (depends on type above).
next_page_path : The name of the header containing the next page number or a JSONPath expression if it's in the payload (depends on type above).
page_size_parameter : The name of the header to send to the API containing the page size.
page_size : The actual page size you wish to receive.
In body pagination🔗
{
"pagination": {
"type": "pagecount",
"location": "body",
"slurp_mode": "page",
"current_page_path": "$.pagination.page",
"page_count_path": "$.pagination.pages",
}
}