Does KoBoToolbox support paginated API?

User Support API
, ,
1

Does kobo support paginated call api

2

Hi Musa, it does. Iā€™m actually working on a project right now (using OpenFn) that makes use of this feature to query for new submissions periodically, clean them, and load them into another database. Check out the API docs below:

Pagination

Two parameters can be used to control pagination.

  • start : Index (zero-based) from which the results start
  • limit : Number of results per page Maximum results per page is 30000

Example: The first ten results

  curl -X GET https://[kpi]/api/v2/assets/aSAvYreNzVEkrWg5Gdcvg/data/?start=0&limit=10

Query submitted data

Provides a list of submitted data for a specific form. Use query parameter to apply form data specific, see [KOBO FORUM IS BLOCKING THIS LINK TO MONGODB!?].

For more details see API Parameters. [KOBO FORUM IS BLOCKING THIS LINK TO FORMHUB!?]. API parameter count is not implemented

GET /api/v2/assets/

{asset_uid}

/data/?query={ā€œfieldā€:ā€œvalueā€} GET /api/v2/assets/

{asset_uid}

/data/?query={ā€œfieldā€:{ā€œopā€: ā€œvalueā€}}"

Example

  curl -X GET 'https://[kpi]/api/v2/assets/aSAvYreNzVEkrWg5Gdcvg/data/?query={"__version__": "vWvkKzNE8xCtfApJvabfjG"}'

curl -X GET ā€˜https://[kpi]/api/v2/assets/aSAvYreNzVEkrWg5Gdcvg/data/?query={ā€œ_submission_timeā€: {ā€œ$gtā€: ā€œ2019-09-01T01:02:03ā€}}ā€™

2 Likes
3

Hi @taylordowns2000,

Welcome to the community! Thank you for providing the solution to the query and making the community rich with KoBoToolbox documentation :clap: :clap: :clap: Expecting the same in the upcoming days as well.

Have a great day!

4

Thanks, Kal! Pleasure to be here. Just FYI, I ran into a problemā€”when I tried to paste from the Kobo docs the reply was blocked because it contained ā€œmore than 2 linksā€. Do you know if thereā€™s a way to lift that limit? (Or do I need to accrue a certain number of ā€œpointsā€ before I can make posts with >2 links?)

2 Likes
5

Hi @taylordowns2000,

You should now be able to smoothly make post within the community. The community should be able to learn a lot from your posts.

Have a great day!

2 Likes