Skip to main content

Pagination

Pagination returns the pages of response. 

There are 6 types of Pagination Type and applicable values are : 

 

Offest

This

holdsthefromAPIandwewill

This

  • Another
    • Response key will the next url value needs of Data Collection

    This

    .

    This

    .
    Pagination TypePaginationpagination we will apply when we have "hasMore":true in our API response.

    image.png

    UI values

    Select offset pagination from the dropdown and fill these values there.

     

    image.png

    • In the above example hasMore key helps to identify upto which page the pagination will be completed , so it will come in User Key
    		 Applicable
  • As we are using Offset pagination so Key Name to Update will be offset
  • Data Collection Key
    		•
    Nodata Pagination the "no_pagination"
    get the response in that key for example here it is ['items'].

    Next URL Pagination

    		 "next_url_pagination""user_key":"pagination will apply when we have URL of next page in our API response. For example we have next link in this key @odata.nextLink"nextLink

     

    image.png

    UI values

    Select Next URL pagination from the dropdown and fill these values there.

    image.png

    • In the above example @odata.nextLink key helps to identify upto which page the pagination will be completed , "response_parameters"so :it "['items']",will "another_response_parameter"come :in "User Key
    • Data Collection Key holds the data from the API and we will get the response in that key for example here it is ['value']"
    OffsetParameter Pagination"offset_pagination""key_name_to_update":"offset",hold "user_key":"hasMore",the "response_parameters"response :of "['items']"
    Totalpage, PageThis Count"total_pages""key_name_to_update":"page",to "user_key":"total_pages",same "response_parameters"as :that "['items']"
    Key.

    Pagination with Body

    		 "pagination_with_body""key_name_to_update"pagination :will "pageToken"apply when we have nextPageToken key in our API response. For example we have next page token in this key `nextPageToken

    image.png

    UI values

    Select Pagination with Body from the dropdown and fill these values there.

     

    image.png

    • In the above example nextPageToken key helps to identify upto which page the pagination will be completed , "user_key"so :it "nextPageToken",will "response_parameters"come :in "User Key
    • As we are getting a token from this pagination so Key Name to Update will be pageToken
    • Data Collection Key holds the data from the API and we will get the response in that key for example here it is ['reports'][0]['data']['rows']"
    Cursor

    Total Page Count Pagination

    		 "cursor_pagination""user_key"pagination :will "next"apply when we have total_pages key in our API response. For example we have total page Count in this key total_pages

    Example 1: When we have the user key in root keys

     

    image.png

    UI values

    Select Total Page Count from the dropdown and fill these values there.

     

    image.png

    • In the above example total_pages key helps to identify upto which page the pagination will be completed , "user_key_url"so :it "Link"will come in User Key
    • As we will be updating page value for going to next page data so Key Name to Update will be page
    • Data Collection Key holds the data from the API and we will get the response in that key for example here it is ['data'].

    Example 2: When we have the user key in nested form.

     

    image.png

    UI values

    Select Total Page Count from the dropdown and fill these values there.

     

    image.png

    • In the above example total_pages key helps to identify upto which page the pagination will be completed , "response_parameters"so :it "will come in User Key, as we can see in the example data total_page key is deep nested so we will pass the User Key as above.
    • As we will be updating page value for going to next page data so Key Name to Update will be page
    • Data Collection Key holds the data from the API and we will get the response in that key for example here it is ['items'data']"
    Back to top