About Rest API - How to get data with some sort of filter, query parameter, etc

[Iso_Ryo]

Hello,

I am looking into how to get submission data as chunked result from our application server through Rest API.

I believe I can get ALL submission data for a form on “https://kc.humanitarianresponse.info/api/v1/data/{formId}”.

But there will be a problem when a form has big amount of submission data since this endpoint seems returning all submission data.

So I was looking for a way to filter the result like getting paginated result or using date filter, but I could not find any information nor documentaion about them.

If anyone can provide any reference or advice would be appreciated.

[cdelaorden]

Hi Iso_Ryo

Check here:

SEL-Columbia/formhub

You can query by submission data using ?query={ “field”: “value” } parameter

And you can also implement pagination using ?skip & ?limit query parameters.

[jnm]

See also:

Link KoBoToolbox to Power Bi using APİ and 30000 rows limitation Problem

You’ll have to retrieve the data in batches. You can use https://kc.humanitarianresponse.info/api/v1/data/XXXX?format=csv&sort={"_id":1}&start=30000 to skip the first 30,000 submissions, for example. The sort part is important; without it, your submissions may not be returned in a consistent order, and the batches may omit or duplicate submissions. You may also use MongoDB query operators to filter your data, as described in “Query submitted data of a specific form” in the documentation at the …