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 its value from the response.

Pagination is used on the following endpoints:

  • GET /reports
  • GET /report-configs
  • GET /reporting-groups

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

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

To retrieve the next page in the above example, add the following value to the next key in the header:

"next": " Q0MtMTAzMDMyLVY3NzY0ODMtODA3MTUtVUFUfDEwYjQ1YzJlNzhhMGFiNDA5ZDlkYWJhZDY3Y2FmZWIxZGUwMGYwN2ZmZmZjMTcwMA"

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

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