API Pagination

[SteveA]

Hi,  

So i've got an API call working (table\records), but i'm wondering from the results, how do you know how many pages I need to loop through to get all the results from a table?  currenlty i've got 950 rows so this could change to over 1000 quickly, just wanted to know how best to handle it.  

Any suggestions? 

[LWSChad]

If you get a full page of results, there is most likely more records to get.

var qPageNumber = 1;

callApi();

function callApi() {
   const qXhr = new XMLHttpRequest;
   const qMethod = 'GET';
   const qPath = 'https://acctid.caspio.com/rest/v2/tables';
   const qTable = 'table_name';
   const qSelect = '*';
   const qPageSize = 1000;
   let qUrl = qPath + '/' + qTable + '/records?q.select=' + qSelect + '&q.pageNumber=' + qPageNumber + '&q.pageSize=' + qPageSize;
   qXhr.open(qMethod, qUrl);
   qXhr.setRequestHeader('Authorization', 'bearer ' + caspioToken);
   qXhr.setRequestHeader("Content-Type", "application/json");
   qXhr.send();
   qXhr.onload = function() {
      const count = JSON.parse(qXhr.responseText).Result.length;
      if(count == 1000) { // if you get a full page of results, there are "very likely" more records
         console.log('a full page of records returned - get the next page');
         qPageNumber = qPageNumber + 1;
         callApi();
      } else {
         console.log('less than a full page of records returned - no more pages');
         // do something with all the records
      }
   }
}

I hope this helps

[ReeganAnne]

In python it is possible to do this with a "while loop":

#start with an empty list
all_records_list = []

# while there is at least one record on a page, get each page and append it to the all_records_list
while len(records_on_page) > 1:
  url = 'https://***.caspio.com/rest/v2/tables/***/records?q.pageSize=1000&q.pageNumber='+ str(i)
  response = requests.get(url,headers=headers)
  response_dictionary = response.json()
  records_on_page = response_dictionary['Result']
  all_records_list.extend(records_on_page)
  # for clarity, print what page number we are on and how many records we have so far
  print("Page number "+ str(i))
  print(len(all_records_list))
  i += 1

Unfortunately Python is my strongest language, so I can only offer help in that regard. But I am sure there is a way to do the same in Javascript with a loop also!

[RuisiHansamu]

Hi there, this forum post may help you out as one of the users provided there guide and reference it here: 

 

[ianGPT]

Hello,

I Just wanted to share details about the Caspio API and its available endpoints. You can explore them here: Caspio API Endpoints