Introduction


This API is based on version 1 of the Kobo API with some significant extensions.

To use the examples you will need to enter a user id and password. However if you are already logged on to the server you should see your own data.

  • user: api
  • password: api

Data


This API gives you access to data that has been submitted to the server

Service Format Description Version Example
/api/v1/data JSON Get a list of the services that retrieve form data 15.12+ https://sg.smap.com.au/api/v1/data
/api/v1/data/{survey ident} JSON Get submitted data from a form. Replace {survey ident} with the survey ident which can be found in the list of services. 15.12+ https://sg.smap.com.au/api/v1/data/1778
/api/v1/data.csv CSV Get a list of services to retrieve form data 15.12+ https://sg.smap.com.au/api/v1/data.csv
/api/v1/data.csv/{key} CSV Get submitted data from the specified form in a CSV file. 15.12+ https://sg.smap.com.au/api/v1/data.csv/1778

Parameters


Parameter Description Version Example
start Retrieve data from the specified primary key 15.12+ https://sg.smap.com.au/api/v1/data.csv?start=2
limit The number of records to retrieve 15.12+ https://sg.smap.com.au/api/v1/data.csv?start=2&limit=1
form Retrieve data for a subform. The available forms will be shown when you call /api/v1/data. This call will return the key for the parent form (parkey) so that its data can be combined with that of the main form 17.06+ https://sg.smap.com.au/api/v1/data/1778?form=2246
start_parkey Parent key to start from. Only useful when working with subform data. 17.06+ https://sg.smap.com.au/api/v1/data/1778?form=2246&start_parkey=200
parkey Use to get a data in a subform that is part of a single record from a parent form. 17.06+ https://sg.smap.com.au/api/v1/data/1778?form=2246&parkey=200
bad Set to "yes" to include records marked as bad in the results. Set to "only" to only return records marked as bad. The default is "none" which will exclude records marked as bad. These include records that have been replaced by editing of the original data. 17.06+ https://sg.smap.com.au/api/v1/data/1778?bad=yes
filename CSV only. If not set the default name is csv.data (forms.csv when retrieving the list of services) 17.06+ https://sg.smap.com.au/api/v1/data.csv/1778?filename=my_data.csv
audit Set to "yes" to include audit data. This data is the time in milliseconds that the user took to answer each question 17.07+ https://sg.smap.com.au/api/v1/data.csv/7019?audit=yes
And for the sub form
https://sg.smap.com.au/api/v1/data.csv/7019?form=11770&audit=yes
merge_select_multiple Set to "yes" to combine all the selected choices for a select multiple into a single column / Json text property. This parameter only applies to surveys created after version 18.03 which use the compressed format for storing select answers 18.04+ https://sg.smap.com.au/api/v1/data.csv/7019?form=11770&merge_select_multiple=yes
geojson Set to "yes" for the data to be returned in geoJson format rather than the kobo api format. 18.07+ https://sg.smap.com.au/api/v1/data.csv/7019?form=11770&geojson=yes
links If set to "true", when getting the data as JSON, then links to additional services that return alternate views of the data are included in the output. For example a link to get the data as a PDF or edit in a webform. 18.07+ https://sg.smap.com.au/api/v1/data/7019?links=true