Paging parameters

  • 60 Views
  • Last Post 03 August 2018
JK26 posted this 25 July 2018

Hi,

In the Reports queries, would it be possible to get more information on the parameters:

  • page
  • page_size

In terms of what they are and how they should be used? Maybe some examples of intended usage would help. In particular is there a way to specify "everything" in the request?

The documentation suggests that these are to control the page ranges for the results, but there doesn't seem to be any way to ascertain the page size of a query before trying to retrieve it, so it can be controlled programmatically.

Thanks,

James

Order By: Standard | Newest | Votes
Shaun Ryan-Izzard posted this 30 July 2018

Can I just confirm, are you talking about the main portal, or the API?

JK26 posted this 02 August 2018

Apologies for not being clear, I'm referring to the API commands. I've added the API tag to the original posting.

Specifically:

/v{version}/reports/{report_type}

and 

 /v{version}/reports/{start_date}/to/{end_date}/{report_type}

Shaun Ryan-Izzard posted this 03 August 2018

No problem.

Our API product is a very useful and potentially important means of accessing our data. However, we have taken on board that the documentation may not be as user friendly as it could be. For this reason, we are starting a piece of work to look again at the way our portal page is presented, along with what information is given and how we might improve this. 

As you can probably appreciate, this is not always a simple task, with a number of people and technical resources needing to be engaged. We therefore ask you to bare with us.

 

 

 

Close