Skip to main content

Pagination

The Reporting API automatically supports pagination to limit responses to 500 records per page. To retrieve the next page, simply add "next" as a key in the header and input the "next" value from the response.

Pagination is used on the following endpoints:

  • GET /reports
  • GET /report-configs

The following is an example of a response limited by pagination:

Json
{ 
    "next": " Q0MtMTAzMDMyLVY3NzY0ODMtODA3MTUtVUFUfDEwYjQ1YzJlNzhhMGFiNDA5ZDlkYWJhZDY3Y2FmZWIxZGUwMGYwN2ZmZmZjMTcwMA", 
     /******RESPONSE BODY******/      
    "lastPage": "false" 
}

To retrieve the next page add the following to the header of the GET /reports

"next": " Q0MtMTAzMDMyLVY3NzY0ODMtODA3MTUtVUFUfDEwYjQ1YzJlNzhhMGFiNDA5ZDlkYWJhZDY3Y2FmZWIxZGUwMGYwN2ZmZmZjMTcwMA"

The following is an example of a response limited by pagination last page:

Json
{ 
    "next": null  
     /******RESPONSE BODY******/      
    "lastPage": "true" 
}